Skip to content
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

Improve README #52

Open
harsh183 opened this issue Jun 29, 2020 · 3 comments
Open

Improve README #52

harsh183 opened this issue Jun 29, 2020 · 3 comments
Assignees
@abhinavtripathy
Labels
documentation Improvements or additions to documentation

Comments

@harsh183
Copy link
Collaborator

Add

  • Install instructions (local, gitpod, cloud9 etc.)
  • More detailed description
  • How to contribute (start with issue, leave comment, create a Pull Request)
  • Heroku deploy instructions
  • Docker/Podman Compose instructions
@harsh183 harsh183 added the documentation Improvements or additions to documentation label Jun 29, 2020
@harsh183
Copy link
Collaborator Author

  • Structure of the database tables (maybe as a UML diagram)

@harsh183
Copy link
Collaborator Author

  • How to run tests
  • How to start the server (w/ and w/o docker)

@harsh183
Copy link
Collaborator Author

#53 this helped but many aspects remain

@abhinavtripathy abhinavtripathy self-assigned this Jul 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abhinavtripathy abhinavtripathy

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@harsh183 @abhinavtripathy