Often a person's story is left untold. However, we believe these stories will inspire people. This web application intends to share the stories around the world by collaborating with people who shares the story (i.e. Characters). Our app focuses on connecting characters with apparel designers, and uploading/selling the apparel in our online shop.
First clone the repository and cd into it. Use the package manager npm
Download the MongoDB community server. Create the database folder for mongodb to store data in your local machine. For windows:
mkdir -p C:/data/db
For mac/linux:
sudo mkdir -p /data/db
To install the backend dependencies, run commands:
cd backend && npm ci
To install the frontend dependencies, run commands:
cd frontend && npm ci
To run the project,
- Start MongoDB server:
mongod
- Start backend:
Open another terminal and run the following command to start the Nodemon server in the backend folder
cd backend && nodemon
If successful, the following line should display in the terminal
Connected to Mongo!
- Start frontend:
Open another terminal and run the following command to start the React project in the frontend folder
cd frontend && npm start
A browser should open on localhost:3000
Please commit to the appropriate branch using the Git Flow model
- Clone the repo
- Create a feature branch (or checkout to the branch you want to make changes on)
- We follow the branch naming standard: [Jira ticket #]
- Commit changes with a message that begin with the ticket number of the task followed by a short description of commit changes
- Push the changes
- Submit a pull request using this template We use JIRA for ticketing