Skip to content

Application that allows users interested in fly fishing to store their expeditions in various ways, such as logging every fish they catch, what fly they used, the weather conditions, etc. We are hoping that fly fishers are able to use this application to catch the fish that they want.

Notifications You must be signed in to change notification settings

CPSC471-W22-Group-8/471_API_Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CPSC 471 Winter 2022 Project: Fly Fishing

Table of Contents

Description

This a full stack application that allows users interested in fly fishing to store their expeditions in various ways, such as logging every fish they catch, what fly they used, the weather conditions, etc. We are hoping that fly fishers are able to use this application to catch the fish that they want.
This project uses Reactas its frontend, and NodeJS with ExpressJS and SQL as the backend.

Tools and Technologies

The following languages and tools were used to build our project:

Installation

Step 1. Node.js

Download Node.js – LTS (Long Term Support) version is recommended for most users

Then, open up your terminal and check if Node is installed:

$ node -v
v16.13.0

Also, check if npm is installed, which comes with Node

$ npm -v
8.1.0

Step 2. Clone GitHub Repository

Enter the following on the terminal of your device to download the project:

$ git clone https://github.com/gabrielawcislo/471_API_Project.git

Step 3. JSON File

Go to the package.json file and go to "script" to confirm that you have the following:

"scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },

Step 4: Install the Required Dependencies

Execute the following commands in your terminal to download all dependencies.

$ npm install

Step 5. Download External Libaries

Also, execcute the following external libraries in your terminal before starting the application:

$ npm install axios
$ npm install @naterial-ui/core

Step 6: Running the Project

Go to the root directory of the project, start the frontend and backend:

$ cd 471_API_Project
$ npm start
$ cd backend                    
$ node main.js                  

You can now open http://localhost:3000 to view the application in your browser, the backend is running at http://localhost:5000

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Authors

This project was made by Computer Science Undergraduate students from the University of Calgary as a final project for the CPSC 471 Winter 2022 course.
Here is the list of authors:

Resources

(back to top)

About

Application that allows users interested in fly fishing to store their expeditions in various ways, such as logging every fish they catch, what fly they used, the weather conditions, etc. We are hoping that fly fishers are able to use this application to catch the fish that they want.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •