# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#about-the-project)
* [Screenshots](#screenshots)
* [Tech Stack](#tech-stack)
* [Features](#features)
* [Color Reference](#color-reference)
* [Environment Variables](#environment-variables)
- [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Running Tests](#running-tests)
* [Run Locally](#run-locally)
* [Deployment](#deployment)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
* [Code of Conduct](#code-of-conduct)
- [FAQ](#faq)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## :star2: About the Project
### :camera: Screenshots
### :space_invader: Tech Stack
Client
Server
Database
DevOps
### :dart: Features
- Feature 1
- Feature 2
- Feature 3
### :art: Color Reference
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color |  #222831 |
| Secondary Color |  #393E46 |
| Accent Color |  #00ADB5 |
| Text Color |  #EEEEEE |
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`API_KEY`
`ANOTHER_API_KEY`
## :toolbox: Getting Started
### :bangbang: Prerequisites
This project uses Yarn as package manager
```bash
npm install --global yarn
```
### :gear: Installation
Install my-project with npm
```bash
yarn install my-project
cd my-project
```
### :test_tube: Running Tests
To run tests, run the following command
```bash
yarn test test
```
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/Louis3797/awesome-readme-template.git
```
Go to the project directory
```bash
cd my-project
```
Install dependencies
```bash
yarn install
```
Start the server
```bash
yarn start
```
### :triangular_flag_on_post: Deployment
To deploy this project run
```bash
yarn deploy
```
## :eyes: Usage
Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.
```javascript
import Component from 'my-project'
function App() {
return
}
```
## :compass: Roadmap
* [x] Todo 1
* [ ] Todo 2
## :wave: Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
### :scroll: Code of Conduct
Please read the [Code of Conduct](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md)
## :grey_question: FAQ
- Question 1
+ Answer 1
- Question 2
+ Answer 2
## :warning: License
Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See LICENSE.txt for more information.
## :handshake: Contact
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
Project Link: [https://github.com/Louis3797/awesome-readme-template](https://github.com/Louis3797/awesome-readme-template)
## :gem: Acknowledgements
Use this section to mention useful resources and libraries that you have used in your projects.
- [Shields.io](https://shields.io/)
- [Awesome README](https://github.com/matiassingers/awesome-readme)
- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#travel--places)
- [Readme Template](https://github.com/othneildrew/Best-README-Template)
