vsb-js / template-project-2023w

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Template for the project 2023 Winter Your project infomration and assigment https://docs.google.com/document/d/1NB0rCDMe5Ua_KcNPXDjWTwBU49EI74RehVgfxSBVoNg/edit?usp=sharing

Your project should be split into 2 folders:

  • Backend
  • Frontend

Each folder should have their own JS projects, so both of them will be have their own package.json, node_modules, .gitignore files etc.

The respository should include exact steps how to run your project. Also we need to be able to run the project on our systems. So please tests that you have all dependencies added to your package.json files and commited.

Don't forget to:

  • Run some prettier on your code
  • Clean this readme before you submit your project

Your project - TODO Name of the application

Description

TODO: Describe what is your application about.

How to run it

TODO: Describe exact steps which needs to be done to run your application locally.

For example:

To run backend do

  1. cd backend and run npm install
  2. ANY Extra steps to run backend
  3. Run npm start

You can see your api in url http://localhost:xxxx/ Tip: (you will need to change your backend port number so it doesn't conflict with frontend port number)

To run frontend do

  1. cd frontend and run npm install
  2. ANY Extra steps to run frontend
  3. Run npm start

You can see your project at http://localhost:3000/

Addtional information

TODO: If you have any additional infomration which you would like to share about the project.

About