@ -1,6 +1,6 @@
< div align = "center" > < div align = "center" >
< img src = "assets/logo.png" alt = "logo" width = " 1 00" height = "auto" / >
< img src = "assets/logo.png" alt = "logo" width = " 2 00" height = "auto" / >
< h1 > Awesome Readme Template< / h1 >
< h1 > Awesome Readme Template< / h1 >
< p >
< p >
@ -8,11 +8,14 @@
< / p >
< / p >
<!-- Badges --> <!-- Badges -->
< p > < p >
< a href = "https://github.com/Louis3797/awesome-readme-template/graphs/contributors" >
< 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" / >
< img src = "https://img.shields.io/github/contributors/Louis3797/awesome-readme-template" alt = "contributors" / >
< / a >
< / 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" >
< 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" / >
< img src = "https://img.shields.io/github/forks/Louis3797/awesome-readme-template" alt = "forks" / >
< / a >
< / a >
@ -27,7 +30,7 @@
< / a >
< / a >
< / p > < / p >
< h4 > < h4 >
< a href = "https://github.com/Louis3797/awesome-readme-template/" > View Demo< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template/" > View Demo< / a >
< span > · < / span >
< span > · < / span >
< a href = "https://github.com/Louis3797/awesome-readme-template" > Documentation< / a >
< a href = "https://github.com/Louis3797/awesome-readme-template" > Documentation< / a >
@ -40,93 +43,110 @@
< br / > < br / >
# Table of Content
<!-- Table of Content -->
< ul >
# :notebook_with_decorative_cover: Table of Content
< li >
- [Table of Content ](#table-of-content )
< a href = "#about-the-project" > About The Project< / a >
* [About the Project ](#about-the-project )
< ul >
+ [Screenshots ](#screenshots )
< li > < a href = "#built-with" > Bu< / a > < / li >
+ [Tech Stack ](#tech-stack )
< li > < a href = "#features" > Features< / a > < / li >
+ [Features ](#features )
< / ul >
+ [Color Reference ](#color-reference )
< / li >
+ [Environment Variables ](#environment-variables )
< li >
* [Getting Started ](#getting-started )
< a href = "#getting-started" > Getting Started< / a >
+ [Prerequisites ](#prerequisites )
< ul >
+ [Installation ](#installation )
< li > < a href = "#prerequisites" > Prerequisites< / a > < / li >
+ [Running Tests ](#running-tests )
< li > < a href = "#installation" > Installation< / a > < / li >
+ [Run Locally ](#run-locally )
< / ul >
+ [Deployment ](#deployment )
< / li >
* [Usage/Examples ](#usage )
< li > < a href = "#usage" > Usage< / a > < / li >
* [Roadmap ](#roadmap )
< li > < a href = "#roadmap" > Roadmap< / a > < / li >
* [Contributing ](#contributing )
< li > < a href = "#contributing" > Contributing< / a > < / li >
+ [Code of Conduct ](#code-of-conduct )
< li > < a href = "#license" > License< / a > < / li >
* [FAQ ](#faq )
< li > < a href = "#contact" > Contact< / a > < / li >
* [License ](#license )
< / ul >
* [Contact ](#contact )
* [Acknowledgements ](#acknowledgements )
## About the Project
<!-- About the Project -->
## :star2: About the Project
### Screenshots
<!-- Screenshots -->
### :camera: Screenshots
< div align = "center" > < div align = "center" >
< img src = "https://placehold.co/600x400?text= Hello+World " alt = "screenshot" / >
< img src = "https://placehold.co/600x400?text= Your+Screenshot+here " alt = "screenshot" / >
< / div > < / div >
### Tech Stack
<!-- TechStack -->
### :space_invader: Tech Stack
#### Client
* [TypeScript ](https://www.typescriptlang.org/ )
* [Next.js ](https://nextjs.org/ )
* [React.js ](https://reactjs.org/ )
* [TailwindCss ](https://tailwindcss.com/ )
#### Server
< details >
< summary > Client< / summary >
* [TypeScript ](https://www.typescriptlang.org/ )
< ul >
* [Express.js ](https://expressjs.com/ )
< li > < a href = "https://www.typescriptlang.org/" > Typescript< / a > < / li >
* [Golang ](https://go.dev/ )
< li > < a href = "https://nextjs.org/" > Next.js< / a > < / li >
* [Nest.js ](https://nestjs.com/ )
< li > < a href = "https://reactjs.org/" > React.js< / a > < / li >
* [Socket.IO ](https://socket.io/ )
< li > < a href = "https://tailwindcss.com/" > TailwindCSS< / a > < / li >
* [Prisma ](https://www.prisma.io/ )
< / ul >
* [Apollo ](https://www.apollographql.com/ )
< / details >
* [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
< 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 >
* [Jenkins ](https://www.jenkins.io/ )
< details >
* [Docker ](https://www.docker.com/ )
< summary > Database< / summary >
* [CircleCI ](https://circleci.com/ )
< 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 -->
### :dart: Features
- Feature 1
- Feature 1
- Feature 2
- Feature 2
- Feature 3
- Feature 3
### Color Reference
<!-- Color Reference -->
### :art: Color Reference
| Color | Hex |
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color |  #0a192f |
| Primary Color |  #222831 |
| Secondary Color |  #f8f8f8 |
| Secondary Color |  #393E46 |
| Accent Color |  #00b48a |
| Accent Color |  #00ADB5 |
| Text Color |  #000000 |
| Text Color |  #EEEEEE |
### Environment Variables
<!-- Env Variables -->
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
To run this project, you will need to add the following environment variables to your .env file
@ -134,10 +154,11 @@ To run this project, you will need to add the following environment variables to
`ANOTHER_API_KEY` `ANOTHER_API_KEY`
<!-- Getting Started -->
## :toolbox: Getting Started
## Getting Started
<!-- Prerequisites -->
### :bangbang: Prerequisites
### Prerequisites
This project uses Yarn as package manager
This project uses Yarn as package manager
@ -145,7 +166,8 @@ This project uses Yarn as package manager
npm install --global yarn
npm install --global yarn
```
```
### Installation
<!-- Installation -->
### :gear: Installation
Install my-project with npm
Install my-project with npm
@ -154,7 +176,8 @@ Install my-project with npm
cd my-project
cd my-project
```
```
### Running Tests
<!-- Running Tests -->
### :test_tube: Running Tests
To run tests, run the following command
To run tests, run the following command
@ -162,8 +185,8 @@ To run tests, run the following command
yarn test test
yarn test test
```
```
<!-- Run Locally -->
### Run Locally
### :running: Run Locally
Clone the project
Clone the project
@ -190,7 +213,8 @@ Start the server
```
```
### Deployment
<!-- Deployment -->
### :triangular_flag_on_post: Deployment
To deploy this project run
To deploy this project run
@ -199,20 +223,11 @@ To deploy this project run
```
```
## Contributing
<!-- Usage -->
## :eyes: Usage
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct` .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.
### 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
```javascript
import Component from 'my-project'
import Component from 'my-project'
@ -222,41 +237,64 @@ function App() {
}
}
```
```
## Roadmap
<!-- Roadmap -->
## :compass: Roadmap
* [x] Todo 1
* [ ] Todo 2
* [ ] Additional browser support
* [ ] Add dark mode
<!-- Contributing -->
## :wave: Contributing
< a href = "https://github.com/Louis3797/awesome-readme-template/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=Louis3797/awesome-readme-template" / >
< / a >
## FAQ
#### Question 1
Contributions are always welcome!
See `contributing.md` for ways to get started.
Answer 1
#### Question 2
<!-- Code of Conduct -->
### :scroll: Code of Conduct
Please read the [Code of Conduct ](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md )
<!-- FAQ -->
## :grey_question: FAQ
Answer 2
- Question 1
+ Answer 1
## License
- Question 2
[MIT ](https://choosealicense.com/licenses/mit/ ) + Answer 2
## Contact
<!-- License -->
## :warning: License
Distributed under the [MIT ](https://choosealicense.com/licenses/mit/ ) License. See LICENSE.txt for more information.
<!-- Contact -->
## :handshake: Contact
Your Name - [@twitter_handle ](https://twitter.com/twitter_handle ) - email@email_client.com
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 )
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 )
<!-- Acknowledgments -->
- [Awesome README ](https://github.com/matiassingers/awesome-readme )
## :gem: Acknowledgements
- [How to write a Good readme ](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project )
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 )
<!-- Links -->
Louis
3 years ago
committed by
GitHub