Getting started

Digital Stories is a MERN application for sharing user created memories

Setting up the project

1. Clone the repo git clone git clone https://github.com/abdullah-2022-skipq/digital-stories.git
2. cd to the cloned folder cd digital-stories
3. cd to the backend folder cd backend
4. install the dependencies npm install
5. set up the .env file according to .env.example
6. set up the Mongo DB
7. run the backend server npm run dev
8. cd to the frontend folder cd ..\frontend
9. install dependencies npm install
10. set up the .env file according to .env.example
11. run the frontend server npm run start

Setting up the project on Docker

1. Clone the repo git clone git clone https://github.com/abdullah-2022-skipq/digital-stories.git
2. cd to the cloned folder cd digital-stories
3. run the command docker-compose -f docker-compose.dev.yml up -d --build

Documentation

Documentation is available here

📷

Acknowledgements

1. SkipQ for the training
2. Coder’s Gyan YouTube for awesome material on best practices and clean code
3. Icon Scout and Icons 8 for icons and other media assets