Project Name / Code

Figma (UI Design URL) · Docs (Outline / Docs URL)

Notes

• New developers who will be added to the project are the customers of this README
• You can add/remove sections as you see fit

Nested README

List of sub-projects/sections which have dedicated README, along with their URL

• Robin

Tech Stack & Key Dependencies

App / Client / Frontend

• Flutter
• Widgetbook
• Providers
• etc

Backend / Server

• NodeJS
• Express
• Parse-server
• Parse-dashboard
• PostgreSQL DB
• etc

Deployment / DevOps

• Github Actions
• Docker & Docker Compose
• etc

Dev / Test Setup

Instructions & pointers to help get started with development or testing of the codebase

App / Client / Frontend

Instructions for frontend

Environment Variables / App Config

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

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

Usage

(This section will be required if this README is related to a library which will be used with other apps.)

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

License

See LICENSE.txt / LICENSE.md / LICENSE for more information.