Skip to content

Commit 5ba31b5

Browse files
committed
Update READMEs
1 parent 51ab2dd commit 5ba31b5

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

backend/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# Backend - Full Stack Trivia API
22

3-
### Installing Dependencies for the Backend
3+
## Installing Dependencies for the Backend
44

55
1. **Python 3.7** - Follow instructions to install the latest version of python for your platform in the [python docs](https://docs.python.org/3/using/unix.html#getting-and-installing-the-latest-version-of-python)
66

77
2. **Virtual Enviornment** - We recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organaized. Instructions for setting up a virual enviornment for your platform can be found in the [python docs](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
88

9-
3. **PIP Dependencies** - Once you have your virtual environment setup and running, install dependencies by naviging to the `/backend` directory and running:
9+
3. **PIP Dependencies** - Once you have your virtual environment setup and running, install all of the required packages we selected within the `requirements.txt` filed by navigating to the `/backend` directory and running:
1010

1111
```bash
1212
pip install -r requirements.txt
1313
```
1414

15-
This will install all of the required packages we selected within the `requirements.txt` file.
16-
1715
4. **Key Dependencies**
1816

1917
- [Flask](http://flask.pocoo.org/) is a lightweight backend microservices framework. Flask is required to handle requests and responses.
@@ -73,7 +71,7 @@ One note before you delve into your tasks: for each endpoint, you are expected t
7371

7472
This README is missing documentation of your endpoints. Below is an example for your endpoint to get all categories. Please use it as a reference for creating your documentation and resubmit your code.
7573

76-
```
74+
```bash
7775
Endpoints
7876
GET '/api/v1.0/categories'
7977
GET ...
@@ -97,7 +95,7 @@ GET '/api/v1.0/categories'
9795

9896
To run the tests, run
9997

100-
```
98+
```bash
10199
dropdb trivia_test
102100
createdb trivia_test
103101
psql trivia_test < trivia.psql

frontend/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Frontend - Full Stack Trivia API
22

3-
### Getting Setup
3+
## Getting Setup
44

55
> _tip_: this frontend is designed to work with [Flask-based Backend](../backend). It is recommended you stand up the backend first, test using Postman or curl, update the endpoints in the frontend, and then the frontend should integrate smoothly.
66
@@ -18,7 +18,7 @@ npm install
1818

1919
> **_tip_**: `npm i`is shorthand for `npm install`
2020
21-
# Required Tasks
21+
## Required Tasks
2222

2323
### Running Your Frontend in Dev Mode
2424

@@ -55,7 +55,7 @@ You can optionally update this game play to increase the number of questions or
5555

5656
> **Spoiler Alert:** If needed, there are details below regarding the expected endpoints and behavior. But, ONLY consult there if necessary, so you give yourself the opportunity to practice understanding code!
5757
58-
# DO NOT PROCEED: ENDPOINT SPOILERS
58+
## DO NOT PROCEED: ENDPOINT SPOILERS
5959

6060
> Only read the below to confirm your notes regarding the expected API endpoint behavior based on reading the frontend codebase.
6161

0 commit comments

Comments
 (0)