mern-app

A simple app to record a list of todos
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
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• Redux
• MongoDB
• Node.js
• Express.js

(back to top)

Getting Started

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.

• Make a free account with MongoDB and create an empty database.

Installation

1. Clone the repo

   git clone https://github.com/FitzHawke/mern-app.git

2. Install NPM packages in root directory and frontend

   npm install
   cd frontend
   npm install

3. Back to root and copy or rename .env.example to .env

   cd ..
   mv .env.example .env

4. Fill out .env with your mongoDB URI
5. Start the dev server from the root directory

   npm run dev

(back to top)

Usage

Deployment

1. Build the frontend

   npm run build

2. Change the NODE_ENV in .env to production.
3. Run the server from the root directory

   npm run start

(back to top)

Roadmap

• Switch Auth over to using passport
• Feature 2
• Feature 3

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.md for more information.

(back to top)

Contact

FitzHawke - @FitzHawke

Project Link: https://github.com/FitzHawke/mern-app

(back to top)

Acknowledgments

(back to top)