From 728687ea33381101c86519550df847f535f6cbbb Mon Sep 17 00:00:00 2001 From: Louis <53270473+Louis3797@users.noreply.github.com> Date: Wed, 6 Apr 2022 12:56:45 +0200 Subject: [PATCH] Finished Readme --- README.md | 246 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 142 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 66beb17..a620297 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- logo + logo

Awesome Readme Template

@@ -8,11 +8,14 @@

- -

+ +

contributors + + last update + forks @@ -27,7 +30,7 @@

-

+

View Demo ยท Documentation @@ -40,93 +43,110 @@
-# Table of Content - - + +# :notebook_with_decorative_cover: Table of Content +- [Table of Content](#table-of-content) + * [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/Examples](#usage) + * [Roadmap](#roadmap) + * [Contributing](#contributing) + + [Code of Conduct](#code-of-conduct) + * [FAQ](#faq) + * [License](#license) + * [Contact](#contact) + * [Acknowledgements](#acknowledgements) -## About the Project + +## :star2: About the Project -### Screenshots + +### :camera: Screenshots
- screenshot + screenshot
-### Tech Stack - -#### Client + +### :space_invader: Tech Stack -* [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/) +
+ Client + +
-#### DevOps +
+ Server + +
-* [Jenkins](https://www.jenkins.io/) -* [Docker](https://www.docker.com/) -* [CircleCI](https://circleci.com/) +
+Database + +
+
+DevOps + +
-### Features + +### :dart: Features - Feature 1 - Feature 2 - Feature 3 -### Color Reference + +### :art: Color Reference | Color | Hex | | ----------------- | ------------------------------------------------------------------ | -| Primary Color | ![#0a192f](https://via.placeholder.com/10/0a192f?text=+) #0a192f | -| Secondary Color | ![#f8f8f8](https://via.placeholder.com/10/f8f8f8?text=+) #f8f8f8 | -| Accent Color | ![#00b48a](https://via.placeholder.com/10/00b48a?text=+) #00b48a | -| Text Color | ![#000000](https://via.placeholder.com/10/000000?text=+) #000000 | +| Primary Color | ![#222831](https://via.placeholder.com/10/222831?text=+) #222831 | +| Secondary Color | ![#393E46](https://via.placeholder.com/10/393E46?text=+) #393E46 | +| Accent Color | ![#00ADB5](https://via.placeholder.com/10/00ADB5?text=+) #00ADB5 | +| Text Color | ![#EEEEEE](https://via.placeholder.com/10/EEEEEE?text=+) #EEEEEE | -### Environment Variables + +### :key: Environment Variables 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` + +## :toolbox: Getting Started -## Getting Started - -### Prerequisites + +### :bangbang: Prerequisites This project uses Yarn as package manager @@ -145,7 +166,8 @@ This project uses Yarn as package manager npm install --global yarn ``` -### Installation + +### :gear: Installation Install my-project with npm @@ -153,8 +175,9 @@ Install my-project with npm yarn install my-project cd my-project ``` - -### Running Tests + + +### :test_tube: Running Tests To run tests, run the following command @@ -162,8 +185,8 @@ To run tests, run the following command yarn test test ``` - -### Run Locally + +### :running: Run Locally Clone the project @@ -190,7 +213,8 @@ Start the server ``` -### Deployment + +### :triangular_flag_on_post: Deployment To deploy this project run @@ -199,20 +223,11 @@ To deploy this project run ``` -## Contributing + +## :eyes: Usage -Contributions are always welcome! - -See `contributing.md` for ways to get started. - -Please adhere to this project's `code of conduct`. - -### 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. -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' @@ -222,41 +237,64 @@ function App() { } ``` -## Roadmap + +## :compass: Roadmap + +* [x] Todo 1 +* [ ] Todo 2 + -* [ ] Additional browser support + +## :wave: Contributing -* [ ] Add dark mode + + + -## FAQ +Contributions are always welcome! + +See `contributing.md` for ways to get started. + + + +### :scroll: Code of Conduct -#### Question 1 +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 + + Answer 1 -#### Question 2 +- Question 2 -Answer 2 + + Answer 2 -## License + +## :warning: License -[MIT](https://choosealicense.com/licenses/mit/) +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 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) + +## :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) -