A curriculum designer that allows the user to organize and keep track of learning resources. All data is stored in a postgreSQL database.
- organize learning goals by year
- keep track of courses and subjects you need to learn
- specify how many hours per week you'll spend on each course, for how long, and other details
- Download the source code
- Add a .env file to the app directory that stores all sensitive data. See the Settings class in config.py for required fields.
- Download postgres and set up a database
- From within the app directory, start the server by running "python -m uvicorn main:app --reload"
- It is recommended to send requests to the API using the postman app or another API develeopment tool.
- Gets all posts and outputs a table for each year to the command line. Is dependent on the user being logged in. The user needs to provide a bearer token.
- Send the GET request to url/posts/
- Responses:
- Create a post. Is dependent on the user being logged in. The user needs to provide a bearer token.
- Send the POST request to url/posts/
- Required request body in json format (only "course" is a required field):
- Responses:
- Update a post. Is dependent on the user being logged in. The user needs to provide a bearer token.
- Send the PUT request to url/posts/{id} where id is the unique id of the post.
- Required request body in json format (only provide fields you want to update):
- Responses:
- Delete a post. Is dependent on the user being logged in. The user needs to provide a bearer token.
- Send the DELETE request to url/posts/{id} where id is the unique id of the post.
- Responses:
- Create a user.
- Send the POST request to url/users/
- Required request body in json format:
- Responses:
- Get a user's information.
- Send the GET request to url/users/{id} where id is the unique id of the user.
- Responses:
- Provide credentials and get a bearer token.
- Send the POST request to url/login
- Required request body in form-data format:
- Responses:
- Create a user
- Login. Then copy the bearer token
- Create a post. Paste the bearer token under the authorization tab.
- See all posts. Paste the bearer token under the authorization tab.
Your curriculim will be output to the command line, like this:
