Skip to content

Instantly share code, notes, and snippets.

@emilhorlyck

emilhorlyck/Base-Readme.md

Last active November 8, 2022 14:11
Show Gist options
  • Save emilhorlyck/8a74c4a0f8a054b621346a743853e933 to your computer and use it in GitHub Desktop.
Save emilhorlyck/8a74c4a0f8a054b621346a743853e933 to your computer and use it in GitHub Desktop.
Download ZIP
Base-Readme
Raw
Base-Readme.md

Logo

Project Title

A brief description of what this project does and who it's for

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Demo

Insert gif or link to demo

Installation

Install my-project with npm

  npm install my-project
  cd my-project

Run Locally

Clone the project

  git clone https://link-to-project

Go to the project directory

  cd my-project

Install dependencies

  npm install

Start the server

  npm run start

Running Tests

To run tests, run the following command

  npm run test

Deployment

To deploy this project run

  npm run deploy

Authors

CodeOwner

Related

Here are some related projects

Awesome README

Links

Production Staging CMS CICD Hosting agreement
Signifly Signifly DatoCMS Buddy Notion link

Maintenance

Maintenance windows er agreed to be:

Central European Time (CET)

Monday Tuesday Wednesday Thursday
14-16 14-16 14-16 14-16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment