New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

start writing documentation #44

Open

hsorathia opened this issue Aug 4, 2021 · 0 comments

Assignees

Labels

Contributor

hsorathia commented Aug 4, 2021

For future development, and documentation for our website overall we should write a small read me containing information about

what we need (re-order this if needed):

what this repo is for
brief background abuot the tech stack / things that people might be interested in
how to setup the repo
how to run the repo

run repo in dev mode
run repo w/ docker
create production build of repo

how to contribute to the repo (talk about the downgrade from yarn 2 -> yarn 1)
the structure of our repo
future testing work

extra stuff that would be good for us to have:

how to create a new api function
how we're doing authentication

hsorathia added the documentation label

hsorathia assigned khainl1110

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