Welcome to Source Sprint's back-end repository!
IEEE-VIT presents Source-Sprint. The event had a workshop to make everyone aquainted with the nuances and basics of Git and Github. Now it's turn for us to open up repositories with issues for participants to work on, each issue is assigned a certain number of points (based on techstack, difficulty etc.). We'll be looking at meaningfull contributions from everyone to begin their journey in Open Sourcing.
Here's an explanation of the project you will be working on!
We are going to make a virtual library! We need two roles, an admin and a user
An admin can:
- Add a book
- Delete a book ( it's no longer in stock for example)
- View detais on the user
- A user can be promoted to an admin by typing a pre-set passcode(not the most secure lol)
A user can:
- Create an account / Log In
- Viewing books of the library
- Return a borrowed book
- View user details
The user and admin routes must be protected, i.e, they can only be accessed when the user logs in! This must be achieved using JWT ( JSON Web Tokens)
We have already made the login route to help you out! Read through the code to understand about how to go about the project
The tech stack used must be Flask, and a database can be made with the help of SQLAlchemy
You can check out the website here.
- Flask
- SQLAlchemy
- Add on to whatever other technology you've used
To get started:
- Clone the repo.
git clone https://github.com/IEEE-VIT/REST_API - Checkout to a new branch.
git checkout -b my-amazing-feature - Make some amazing changes.
git add .git commit -m "A short description about the feature."git push origin my-amazing-feature- Open a pull request to tons of issues we've curated for you :)
To start contributing, check out CONTRIBUTING.md . New contributors are always welcome as that is the purpose of this repo.
You can test the routes in the repository with Postman. (You may have to download the application)
Help
Thanks goes to these wonderful people:
|
Varun Sudhir 📖💻 |
Ishaan K Mathur 📖💻 |
Made with ❤ by IEEE-VIT