# Table of Content
## About the Project
### Screenshots
### Tech Stack
#### Client
* [TypeScript](https://www.typescriptlang.org/)
* [Next.js](https://nextjs.org/)
* [React.js](https://reactjs.org/)
* [TailwindCss](https://tailwindcss.com/)
#### Server
* [TypeScript](https://www.typescriptlang.org/)
* [Express.js](https://expressjs.com/)
* [Golang](https://go.dev/)
* [Nest.js](https://nestjs.com/)
* [Socket.IO](https://socket.io/)
* [Prisma](https://www.prisma.io/)
* [Apollo](https://www.apollographql.com/)
* [GraphQL](https://graphql.org/)
#### Database
* [MySQL](https://www.mysql.com/)
* [PostgreSQL](https://www.postgresql.org/)
* [Redis](https://redis.io/)
* [Neo4j](https://neo4j.com/)
* [MongoDB](https://www.mongodb.com/)
#### DevOps
* [Jenkins](https://www.jenkins.io/)
* [Docker](https://www.docker.com/)
* [CircleCI](https://circleci.com/)
### Features
- Feature 1
- Feature 2
- Feature 3
### Color Reference
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color |  #0a192f |
| Secondary Color |  #f8f8f8 |
| Accent Color |  #00b48a |
| Text Color |  #000000 |
### Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`API_KEY`
`ANOTHER_API_KEY`
## Getting Started
### Prerequisites
This project uses Yarn as package manager
```bash
npm install --global yarn
```
### Installation
Install my-project with npm
```bash
yarn install my-project
cd my-project
```
### Running Tests
To run tests, run the following command
```bash
yarn test test
```
### 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
```
### Deployment
To deploy this project run
```bash
yarn deploy
```
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.
### Code of Conduct
Please read the [Code of Conduct](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md)
## Usage/Examples
```javascript
import Component from 'my-project'
function App() {
return
}
```
## Roadmap
* [ ] Additional browser support
* [ ] Add dark mode
## FAQ
#### Question 1
Answer 1
#### Question 2
Answer 2
## License
[MIT](https://choosealicense.com/licenses/mit/)
## 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)
## Acknowledgements
- [Awesome Readme Templates](https://awesomeopensource.com/project/elangosundar/awesome-README-templates)
- [Awesome README](https://github.com/matiassingers/awesome-readme)
- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)
