📷 Screenshots

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
  • Color Reference
  • Environment Variables
• Getting Started
  • Prerequisites
  • Installation
  • Running Tests
  • Run Locally
  • Deployment
• Usage
• Roadmap
• Contributing
  • Code of Conduct
• FAQ
• License
• Contact
• Acknowledgements

🌟 About the Project

👾 Tech Stack

Client

• Typescript
• Next.js
• React.js
• TailwindCSS

Server

• Typescript
• Express.js
• Golang
• Nest.js
• SocketIO
• Prisma
• Apollo
• GraphQL

Database

• MySQL
• PostgreSQL
• Redis
• Neo4j
• MongoDB

DevOps

• Docker
• Jenkins
• CircleCLI

🎯 Features

• Feature 1
• Feature 2
• Feature 3

🔑 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

• Front End
• Back End