Table of Contents
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
This section should list any major frameworks/libraries used to bootstrap your project.
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.
This is an example of how to list things you need to use the software and how to install them.
- npm
- yarn
- node
- docker
-
Clone the repo
git clone https://github.com/mudiman/todo-mern-dt.git
-
Install NPM packages for server
cd apps/api/ && yarn install
-
Rename .env.sample to .env and update configuration
-
Install NPM packages for client
cd apps/web/ && yarn install
cd src/client
yarn install
yarn start
cd src/server
yarn install
make copy of .env.sample as .env and update the config
yarn start
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
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
- 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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Mudassar Ali - @mudassarali - mudassar.ali@gmail.com
Project Link: https://github.com/mudiman/todo-mern-dt