Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.15 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.15 KB

MERN Template

Version Documentation Maintenance License: MIT

Placeholder - Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quidem consequatur unde aut dolores odio hic, accusamus recusandae ipsam illum enim voluptatibus obcaecati totam tempora eum quod sapiente.

🖼️ Screenshots

Alt Text


Alt Text

⌨️📟 Running the project

To run the project, just run the start command found in the package.json.

$ yarn start

Make sure you include a .env file with a MONGODB_URI property or else a defualt testdb will be used on your localhost. Please also ensure a MongoDB Server is running prior to running the project.
Note: This documentation uses yarn commands, but npm will also work.

🔬 Run tests

The test file is located within the test folder in the root directoy. To run the tests, simply run the test command:

$ yarn test

👨🏻‍💻 Author

Firstname Lastname - email@email.com

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check Issues page and the Contributing Guide.

❤️ Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Firstname Lastname email@email.com.
This project is LICENSE licensed.