finalprojectf22-nostruggle

finalprojectf22-nostruggle created by GitHub Classroom

How to run

Using npm script:

npm install
npm run dev

Run the server:

cd server
npm install
npm run dev

Run the client:

cd client
npm install
npm start

Documentation

Client

The documentation hugo webpages for the client side can be found in documentation/frontend. View the deployed version at https://no-struggle-doc.netlify.app/

Server

The server must be running on localhost:2800 in order to view the api endpoints documentation. It can be found by opening documentation/api/index.html.

Steps:

1. Run the server, such as following the commands above.
2. View documentation/api/index.html, either by running it or opening it, depending the environment

General plan

Motivation :

Often first year students feel lost because of a lack of social circle and increasing complexity of the material they study. Due to vast resources available on the internet , it becomes difficult for them to filter the applications and advice that are most productive to their learning. Upper year students who have a strong desire to help freshmen navigate university are unable to do so due to lack of connection. Our website is a one stop solution designed to help first year computer science students to connect with other students , join various forums to get ideas and their questions answered. We also have an essential toolkit to help our users with everyday calculations, linear algebra and calculus. In order to promote good study habits, there is also a study timer with which users can log their study hours and schedule tasks. The main incentive is to make all useful tools at one place to help students thrive in every way possible.

Do you use git flow?

Yes we use git flow with main being our main branch

What do you name your branches?

Our main branch will be named “main” and we will have a developer branch ‘dev’ and multiple feature branches. Feature branches will be used to develop new features and will be merged to the developer branch. Each time during a partial release of the project , a release branch will be created . A hotfix branch will also be created to make hotfixes.

Do you use github issues or another ticketing website?

We will be using JIRA to track our progress with each successive sprint.

Do you use pull requests?

Yes we would be using pull requests before merging and the code will be reviewed by at least two other members of the team.

Rough ideas :

• Stop solution
• People can collaborate
• Exchange ideas for project and find team members
• Use mathematical tools
• Like minded people
• Helps grab central idea of required course and get required help to make it to post
• Helps improve productivity