<!--
Hey, thanks for using the awesome-readme-template template.
If you have any enhancements, then fork this project and create a pull request
or just open an issue with the label "enhancement".
Don't forget to give this project a star for additional support ;)
Maybe you can mention me or this repo in the acknowledgements too
-->
< div align = "center" >
< img src = "assets/logo.png" alt = "logo" width = "200" height = "auto" / >
< h1 > Awesome Readme Template< / h1 >
< p >
An awesome README template for your projects!
< / p >
<!-- Badges -->
< p >
< a href = "https://github.com/Louis3797/awesome-readme-template/graphs/contributors" >
< img src = "https://img.shields.io/github/contributors/Louis3797/awesome-readme-template" alt = "contributors" / >
< / a >
< a href = "" >
< img src = "https://img.shields.io/github/last-commit/Louis3797/awesome-readme-template" alt = "last update" / >
< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template/network/members" >
< img src = "https://img.shields.io/github/forks/Louis3797/awesome-readme-template" alt = "forks" / >
< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template/stargazers" >
< img src = "https://img.shields.io/github/stars/Louis3797/awesome-readme-template" alt = "stars" / >
< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template/issues/" >
< img src = "https://img.shields.io/github/issues/Louis3797/awesome-readme-template" alt = "open issues" / >
< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template/blob/master/LICENSE.txt" >
< img src = "https://img.shields.io/github/license/Louis3797/awesome-readme-template" alt = "license" / >
< / a >
< / p >
< h4 >
< a href = "https://github.com/Louis3797/awesome-readme-template/" > View Demo< / a >
< span > · < / span >
< a href = "https://github.com/Louis3797/awesome-readme-template" > Documentation< / a >
< span > · < / span >
< a href = "https://github.com/Louis3797/awesome-readme-template/issues/" > Report Bug< / a >
< span > · < / span >
< a href = "https://github.com/Louis3797/awesome-readme-template/issues/" > Request Feature< / a >
< / h4 >
< / div >
< br / >
<!-- Table of Contents -->
# 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 )
<!-- About the Project -->
## About the Project
<!-- Screenshots -->
### Screenshots
< div align = "center" >
< img src = "https://placehold.co/600x400?text=Your+Screenshot+here" alt = "screenshot" / >
< / div >
<!-- TechStack -->
### Tech Stack
< details >
< summary > Client< / summary >
< ul >
< li > < a href = "https://www.typescriptlang.org/" > Typescript< / a > < / li >
< li > < a href = "https://nextjs.org/" > Next.js< / a > < / li >
< li > < a href = "https://reactjs.org/" > React.js< / a > < / li >
< li > < a href = "https://tailwindcss.com/" > TailwindCSS< / a > < / li >
< / ul >
< / details >
< details >
< summary > Server< / summary >
< ul >
< li > < a href = "https://www.typescriptlang.org/" > Typescript< / a > < / li >
< li > < a href = "https://expressjs.com/" > Express.js< / a > < / li >
< li > < a href = "https://go.dev/" > Golang< / a > < / li >
< li > < a href = "https://nestjs.com/" > Nest.js< / a > < / li >
< li > < a href = "https://socket.io/" > SocketIO< / a > < / li >
< li > < a href = "https://www.prisma.io/" > Prisma< / a > < / li >
< li > < a href = "https://www.apollographql.com/" > Apollo< / a > < / li >
< li > < a href = "https://graphql.org/" > GraphQL< / a > < / li >
< / ul >
< / details >
< details >
< summary > Database< / summary >
< ul >
< li > < a href = "https://www.mysql.com/" > MySQL< / a > < / li >
< li > < a href = "https://www.postgresql.org/" > PostgreSQL< / a > < / li >
< li > < a href = "https://redis.io/" > Redis< / a > < / li >
< li > < a href = "https://neo4j.com/" > Neo4j< / a > < / li >
< li > < a href = "https://www.mongodb.com/" > MongoDB< / a > < / li >
< / ul >
< / details >
< details >
< summary > DevOps< / summary >
< ul >
< li > < a href = "https://www.docker.com/" > Docker< / a > < / li >
< li > < a href = "https://www.jenkins.io/" > Jenkins< / a > < / li >
< li > < a href = "https://circleci.com/" > CircleCLI< / a > < / li >
< / ul >
< / details >
<!-- Features -->
### Features
- Feature 1
- Feature 2
- Feature 3
<!-- Color Reference -->
### Color Reference
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color |  #222831 |
| Secondary Color |  #393E46 |
| Accent Color |  #00ADB5 |
| Text Color |  #EEEEEE |
<!-- Env Variables -->
### 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 -->
## Getting Started
<!-- Prerequisites -->
### Prerequisites
This project uses Yarn as package manager
```bash
npm install --global yarn
```
<!-- Installation -->
### Installation
Install my-project with npm
```bash
yarn install my-project
cd my-project
```
<!-- Running Tests -->
### Running Tests
To run tests, run the following command
```bash
yarn test test
```
<!-- Run Locally -->
### 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 -->
### Deployment
To deploy this project run
```bash
yarn deploy
```
<!-- Usage -->
## 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 < Component / >
}
```
<!-- Roadmap -->
## Roadmap
* [x] Todo 1
* [ ] Todo 2
<!-- Contributing -->
## Contributing
< a href = "https://github.com/Louis3797/awesome-readme-template/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=Louis3797/awesome-readme-template" / >
< / a >
Contributions are always welcome!
See `contributing.md` for ways to get started.
<!-- 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 )
<!-- FAQ -->
## FAQ
- Question 1
+ Answer 1
- Question 2
+ Answer 2
<!-- License -->
## License
Distributed under the [MIT ](https://choosealicense.com/licenses/mit/ ) License. See LICENSE.txt for more information.
<!-- Contact -->
## 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 )
<!-- Acknowledgments -->
## 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 )
