docs: update readme #138
docs: update readme #138
Conversation
Codecov Report
@@ Coverage Diff @@
## master #138 +/- ##
=======================================
Coverage 81.44% 81.44%
=======================================
Files 29 29
Lines 469 469
=======================================
Hits 382 382
Misses 87 87 Continue to review full report at Codecov.
|
| @@ -3,88 +3,108 @@ | |||
|  | |||
| [](https://codecov.io/gh/codebuddies/backend) | |||
|
|
|||
| **Note:** This project is currently _in development_ | |||
|
|
||
| The API spec all the proof-of-concepts: https://app.swaggerhub.com/apis-docs/billglover/CodeBuddies/0.0.1 | ||
| - [Background] | ||
| - [The API spec all the proof-of-concept] |
There was a problem hiding this comment.
This should be linking to codebuddies/codebuddies#1136 and https://app.swaggerhub.com/apis-docs/billglover/CodeBuddies/0.0.1 respectively, right?
So:
The [API spec](https://app.swaggerhub.com/apis-docs/billglover/CodeBuddies/0.0.1) of our proof-of-concept
etc.
| ## Setup | ||
|
|
||
| Although it is possible to run this locally, we recommend you run CodeBuddies locally using Docker. We assume you have Docker installed, but if not head on over to the Docker [Getting Started](https://www.docker.com/products/docker-desktop) guide and install Docker for your operating system. | ||
| We recommend you run CodeBuddies locally using Docker. We assume you have Docker installed, but if not head on over to the Docker [Getting Started] guide and install Docker for your operating system. |
There was a problem hiding this comment.
The URL "Getting Started" is linking to is missing here as well.
There was a problem hiding this comment.
The link has been moved to the bottom https://github.com/codebuddies/backend/compare/feature/readme-update#diff-04c6e90faac2675aa89e2176d2eec7d8R233
I've used a reference style link format for readability. See [link text itself]: http://www.reddit.com here https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
There was a problem hiding this comment.
Ohh, TIL! Thanks, didn't know it was possible to do this in markdown before, for some reason 😅
README.md
Outdated
| - update resource | ||
| - list resource | ||
| - search resources | ||
| - [ ] save resource |
There was a problem hiding this comment.
I just realized we can tick off ALL of these checkmarks, haha 🎉 So we can put an "x" next to each of them!
The only one we can't tick off yet is [ ] Calendar/hangouts
|
|
||
| To stop the application and remove all containers, run the following. | ||
| 6. You can populate the database with some random test data for development purposes by running |
There was a problem hiding this comment.
Ohh, one idea here: maybe it would be helpful to add @chris48s' documentation about the init_data --help command:
$ docker-compose run --rm app ./manage.py init_data --help
usage: manage.py init_data [-h] [--clear-db] [--num-users NUM-USERS]
[--num-tags NUM-TAGS]
[--num-resources NUM-RESOURCES] [--version]
[-v {0,1,2,3}] [--settings SETTINGS]
[--pythonpath PYTHONPATH] [--traceback]
[--no-color] [--force-color]
Initialize the DB with some random fake data for testing and development
optional arguments:
--clear-db Clear existing data from the DB before creating test
data
--num-users NUM-USERS
Number of `User` objects to create (default 10)
--num-tags NUM-TAGS Number of `Tag` objects to create (default 10)
--num-resources NUM-RESOURCES
Number of `Resource` objects to create (default 10)
-v {0,1,2,3}, --verbosity {0,1,2,3}
Verbosity level; 0=minimal output, 1=normal output,
2=verbose output, 3=very verbose output
This is from his PR at #129
|
docs: Thanks for the feedback @lpatmo, I've added the requested changes as a second commit. |
No description provided.