Todo MERN

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Todo sample app

This is mono repo project build using Turborepo. Sample todo full stack app with react.js and express.js and some test, docker and github action workflow It includes all major production grade application packages

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project.

• Turborepo
• React.js
• Express
• Jest
• MirageJs
• React Router
• Docker
• MongoDB
• PM2
• Mocha
• Chai

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• yarn
• node
• docker

Installation

1. Clone the repo

   git clone https://github.com/mudiman/todo-mern-dt.git

2. Install NPM packages for server

   cd apps/api/ && yarn install

3. Rename .env.sample to .env and update configuration

4. Install NPM packages for client

   cd apps/web/ && yarn install

(back to top)

Usage

Client

cd src/client
yarn install
yarn start

Server

cd src/server
yarn install
make copy of .env.sample as .env and update the config
yarn start

Using Turbo build command

on root run below command which run all dev command in sub apps
yarn run dev
yarn run lint // to check for linking issue
yarn run format // to format code

Using Docker

docker-compose build
docker-compose up -d
Note: Curring dockerfile is setup for production mode so it will not watch for changes. If want to make changes run directly or modify dockerfile

(back to top)

Roadmap

• Add Changelog
• Add back to top links
• [] Add Dockerfile.dev for local developerment with support to watch for changes
• [] Multi-language Support
  • [] Chinese
  • [] Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Mudassar Ali - @mudassarali - mudassar.ali@gmail.com

Project Link: https://github.com/mudiman/todo-mern-dt

(back to top)