An awesome Project to describe README
Demo
Write about 1-2 paragraphs describing the purpose of your project.
Ex. Are you looking for a quick and easy way to action, action, and action? The (name of application) is the greatest and most accurate application to do this for you. It helps you to (list of activities). The (name of application) provides a simple design to ensure having the best user experience.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Visual Studio Code follow this link to install.
- Git Bash follow this link to install.
- MongoDB follow this link to install.
- Node.js follow this link to install.
- Clone the repo to your local machine using git bash.
git clone https://github.com/your_username_/Project-Name.git
- Install packeges repeat this step in backend and frontend folder
npm i
- Run server using git bash inside backend folder
npm run dev
- Run application using git bash inside frontend folder
npm run start
Now app ready to use
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Ex.
- You don't have to register to navigate our web app
- You can click on the Home tab provided in the navigation bar to view the home section
- You can click on the Add to cart button to add this product to your cart but you have to be one of our users, so you should create an account
- MongoDB - Database
- Express JS - Server Framework
- React JS - Web Framework
- Node JS - Server Environment
Your trello board link Trello
This project is guided by ©️ MERAKI Academy