-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
867bcf8
commit b13dd3e
Showing
1 changed file
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,55 @@ | ||
# mernTemplate | ||
<h1 align="center">MERN Template</h1> | ||
<p align="center"> | ||
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" /> | ||
<a href=" "> | ||
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" /> | ||
</a> | ||
<a href="https://github.com/MoralesJonathan/simple-console-colors/graphs/commit-activity"> | ||
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" /> | ||
</a> | ||
<a href="https://github.com/MoralesJonathan/simple-console-colors/blob/master/LICENSE"> | ||
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" /> | ||
</a> | ||
</p> | ||
|
||
> 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 | ||
<img alt="Alt Text" src="https://link-to-image.whatever"> | ||
<br/> | ||
<img alt="Alt Text" src="https://link-to-image.whatever"> | ||
|
||
|
||
## ⌨️📟 Running the project | ||
To run the project, just run the start command found in the `package.json`. | ||
```sh | ||
$ 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. | ||
<br/>_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: | ||
```sh | ||
$ yarn test | ||
``` | ||
|
||
## 👨🏻💻 Author | ||
|
||
**Firstname Lastname - <[email protected]>** | ||
|
||
* Github: [@username](https://github.com/username) | ||
|
||
## 🤝 Contributing | ||
|
||
Contributions, issues and feature requests are welcome!<br />Feel free to check [Issues page](link-to-issues-page) and the [Contributing Guide](Link-to-CONTRIBUTING.md). | ||
|
||
## ❤️ Show your support | ||
|
||
Give a ⭐️ if this project helped you! | ||
|
||
## 📝 License | ||
|
||
Copyright © 2019 [Firstname Lastname <[email protected]>](https://github.com/username).<br /> | ||
This project is [LICENSE](link-to-LICENSE.md) licensed. |