Software Fellowship 2021 | Project 1

Instructions

1. Clone this repo using git, or download it and later upload it through GitHub GUI itself. The previous one is the recommended way.
2. Create a virtual environment and activate it. Detailed instructions are provided here.
3. Enter the following in the terminal to install the required dependencies.

  pip install -r requirements.txt

4. The repo contains code for mainly two servers.
   1. api.py for creating an API
   2. app.py for displaying them using jinja in HTML
5. The functions in the provided files should be updated as instructed there to make a fully functioning, beautiful web app.
6. This repo should contain a working code within the deadline, i.e., 15th of July.

Project Components

REST API

• Use the api.py provided in this repo for creating a REST API server run in post 5001.
• The server should request the characters API from The One API using the token provided by the website.
• The file is a complete REST API server where the frequently used HTTP Methods are implemented, viz. GET, POST, and DELETE.
  • NOTE: We do not require PUT requests to be implemented for grading.
• Read the comments in the file to make a fully functioning REST API yourself.
• It acts like a proxy server to a small portion of The One API.

API KEY

• Get your own API Key by logging in The One API.
• Since the API Key rate limits the call to the API, sharing them is not a good idea. In fact, having identical keys for two projects will make us suspicious about the authenticity of the project
• The key provided should be kept in config.py to make your REST API server work properly.

FLASK SERVER

• Use the app.py provided in this repo for creating a server run in post 5000.
• The server should request the characters API from the server described above.
• The server should return only HTML pages populating the data requested.
• Read the comments in the file to make a fully functioning web server.

HTML Templates

• The templates for the flask server are inside the templates directory.
• Jinja reads the template and converts it into pure HTML before the server sends a response.
• The templates provided are just a minimal working version. You need to add styles to them either by writing the CSS yourself or using its frameworks like Bootstrap.
• Since the styling part is done by you, it will be absurd if your HTML pages appear the same as the other participants. If we find that one project is a copy of another, both projects will be discarded.