diff --git a/SLIMMED-README.md b/SLIMMED-README.md new file mode 100644 index 0000000..571192b --- /dev/null +++ b/SLIMMED-README.md @@ -0,0 +1,260 @@ + + +
+ + logo +

Awesome Readme Template

+ +

+ An awesome README template for your projects! +

+ + + +

+ + contributors + + + last update + + + forks + + + stars + + + open issues + + + license + +

+ +

+ View Demo + · + Documentation + · + Report Bug + · + Request Feature +

+
+ +
+ + +# :notebook_with_decorative_cover: Table of Contents + +- [About the Project](#about-the-project) + * [Tech Stack](#tech-stack) + * [Features](#features) + * [Color Reference](#color-reference) + * [Environment Variables](#environment-variables) +- [Getting Started](#getting-started) + * [Prerequisites](#prerequisites) + * [Installation](#installation) + * [Run Locally](#run-locally) +- [Usage](#usage) +- [Roadmap](#roadmap) +- [Contributing](#contributing) + * [Code of Conduct](#code-of-conduct) +- [License](#license) +- [Contact](#contact) + + + +## :star2: About the Project + +
+ screenshot +
+ + + +### :space_invader: Tech Stack + +
+ Client + +
+ +
+ Server + +
+ +
+Database + +
+ +
+DevOps + +
+ + +### :dart: Features + +- Feature 1 +- Feature 2 +- Feature 3 + + +### :art: Color Reference + +| Color | Hex | +| ----------------- | ------------------------------------------------------------------ | +| 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 | + + + +### :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 + + +### :bangbang: Prerequisites + +This project uses Yarn as package manager + +```bash + npm install --global yarn +``` + + +### :gear: Installation + +Install my-project with npm + +```bash + yarn install my-project + cd my-project +``` + + + +### :running: 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 +``` + + + +## :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. + + +```javascript +import Component from 'my-project' + +function App() { + return +} +``` + + +## :compass: Roadmap + +* [x] Todo 1 +* [ ] Todo 2 + + +## :wave: Contributing + + + + + + +Contributions are always welcome! + +See `contributing.md` for ways to get started. + + + +### :scroll: Code of Conduct + +Please read the [Code of Conduct](https://github.com/Louis3797/awesome-readme-template/blob/master/CODE_OF_CONDUCT.md) + + + +## :warning: License + +Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See LICENSE.txt for more information. + + + +## :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) +