Blackchronicler / corseadminapi

Developing a course administration API

Course Administration API

Learning how to build an API using FastAPI and MongoDB.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The goal of this project is to learn how to create a system that processes course-related queries. A course administration API will be developed using FastAPI and MongoDB. The system will allow users to access course details, view chapters, rate individual chapters, and aggregate ratings. The API will be able to:

• Show a comprehensive course overview
• Fetch a list of all courses
• List detailed information about certain chapters
• Record user scores for each chapter.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started [To be updated]

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites [To be updated]

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation [To be updated]

1. Get a free API Key at https://example.com

2. Clone the repo

   git clone https://github.com/Blackchronicler/corseadminapi.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage [To be updated]

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Parse and insert data into DB
• Design API endpoints
• Automate testing of API endpoints
• Containerize application with docker

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated :D.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/Blackchronicler/corseadminapi

(back to top)

Acknowledgments [To be updated]

(back to top)