You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7.6 KiB

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


Table of Contents

About the Project

Screenshots

screenshot

Tech Stack

Client
Server
Database
DevOps

Features

  • Feature 1
  • Feature 2
  • Feature 3

Color Reference

Color Hex
Primary Color #222831 #222831
Secondary Color #393E46 #393E46
Accent Color #00ADB5 #00ADB5
Text Color #EEEEEE #EEEEEE

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

Prerequisites

This project uses Yarn as package manager

 npm install --global yarn

Installation

Install my-project with npm

  yarn install my-project
  cd my-project

Running Tests

To run tests, run the following command

  yarn test test

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

Deployment

To deploy this project run

  yarn deploy

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 />
}

Roadmap

  • Todo 1
  • Todo 2

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Code of Conduct

Please read the Code of Conduct

FAQ

  • Question 1

    • Answer 1
  • Question 2

    • Answer 2

License

Distributed under the no License. See LICENSE.txt for more information.

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/Louis3797/awesome-readme-template

Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.