Awesome
<!-- 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"> <img src="https://img.shields.io/github/license/Louis3797/awesome-readme-template.svg" 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 -->:notebook_with_decorative_cover: Table of Contents
:star2: About the Project
<!-- Screenshots -->:camera: Screenshots
<div align="center"> <img src="https://placehold.co/600x400?text=Your+Screenshot+here" alt="screenshot" /> </div> <!-- TechStack -->:space_invader: 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 -->:dart: Features
- Feature 1
- Feature 2
- Feature 3
:art: Color Reference
| Color | Hex |
|---|---|
| Primary Color | |
| Secondary Color | |
| Accent Color | |
| Text Color |
: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
<!-- Prerequisites -->:bangbang: Prerequisites
This project uses Yarn as package manager
npm install --global yarn
:gear: Installation
Install my-project with npm
yarn install my-project
cd my-project
:test_tube: Running Tests
To run tests, run the following command
yarn test test
:running: Run Locally
Clone the project
git clone https://github.com/Louis3797/awesome-readme-template.git
Go to the project directory
cd my-project
Install dependencies
yarn install
Start the server
yarn start
:triangular_flag_on_post: Deployment
To deploy this project run
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.
import Component from 'my-project'
function App() {
return <Component />
}
:compass: Roadmap
- Todo 1
- Todo 2
: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>Contributions are always welcome!
See contributing.md for ways to get started.
:scroll: Code of Conduct
Please read the Code of Conduct
<!-- FAQ -->:grey_question: FAQ
-
Question 1
- Answer 1
-
Question 2
- Answer 2
:warning: License
Distributed under the no License. See LICENSE.txt for more information.
<!-- Contact -->:handshake: Contact
Your Name - @twitter_handle - email@email_client.com
Project Link: https://github.com/Louis3797/awesome-readme-template
<!-- Acknowledgments -->:gem: Acknowledgements
Use this section to mention useful resources and libraries that you have used in your projects.