Skip to content

Instantly share code, notes, and snippets.

@luisjunco

luisjunco/readme-project-2.md

Last active November 23, 2023 17:50
Show Gist options
  • Save luisjunco/3237da35065f2ea917aa804cd558f9b2 to your computer and use it in GitHub Desktop.
Save luisjunco/3237da35065f2ea917aa804cd558f9b2 to your computer and use it in GitHub Desktop.
Download ZIP
Requirements README project 2
Raw
readme-project-2.md

README Project 2

  • Description

    • Brief description of the project

  • Instructions to run this app in my computer. Probably something like this:

    • git clone
    • how to install dependencies (npm install)
    • in case you're using environment variables: explain that I'd need to create a .env file and add environment variables (remember to detail all the variables that I may need to create, if I need to create an account to get some credentials etc.)
    • how to run the application (ex. npm run dev)

  • Demo

    • Link where users can see the final version of your project (Netlify)

Resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment