jtomassoni / repo-template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Anything in this template can be edited or deleted in order to make it more related to the topic

Each template can be initialized with a project that makes it easy for others to tell how complete it is

Repos can be initialized with an X0 "number" if you are not sure where it goes in the number tree

Topic Name

Description

Full description of the topic

Prerequisite Fundamentals

List of things that the user should understand before trying to learn or implement this

  • fundamental 1
  • fundamental 2
  • fundamental 3

Before Getting Started

Things to have installed or set up before diving into the code (eg. create-react-app globally, mongoDB, python3 etc.)

  • install 1
  • install 2
  • install 3
  • maybe there are no installs and this can just be run in the browser

Extra Things to Note

Users should keep these things in mind. Let them know things won't work unless they have done these

  • In order to visualize the database you nee to have a frontend with this
  • You need an API key for this
  • Superusers should have this permission to do that

How To Navigate (if necessary)

Simple explanation of how to navigate the project folders (if not already explained in the project's README.md)

About