Athenaeum is an application dedicated to connecting you with the books you're searching for. Our goal: to search the web and find you the books you seek at a reputable distributor and a good price. Using Athenaeum, you can simplify your journey and minimize your costs as you find the resources you need for class. We specifically aim to target students, but all lovers of books are welcome to partake. We currently have no users.
At present, you can add, edit, or delete a book from your local machine. If the book has a link to purchase, the "Buy" button will direct you to the appropriate page. If you search for a book that exists in our database, it will direct you to the appropriate Wikipedia link for that book.
Our web scraper is currently in progress (see \workInProgress
for what we have so far), but we intend to integrate it with our current page to allow for a more optimized searching experience that also presents pricing. We also intend to create a "Buy/Sell" user forum, as well as a functional login page.
Currently, to get everything up and running:
\Athenaeum
and run pip install -r requirements.txt
To run the backend:
Navigate to the backend directory, \Athenaeum\backend
Create a new file \Athenaeum\backend\.env
and add the secret key in the file:
SECRET_KEY = '<secret key>'
If running for the first time, run the migrate commands (if confused, review help here)
Run python manage.py runserver
Navigate to http://localhost:8000/api/books/ To stop the server, hit CTRL+C
\Athenaeum\frontend
npm ci
npm start
.env
, NOT backend.env
python
doesn't work, try python3
As an open-source project, we declare our governance model to be a "do-ocracy"; for insight into what that means, checkout this link from Red Hat.
Our current contributors are:
For more information on contributing, check out CONTRIBUTING.md. To report a bug, request a feature, or communicate with the developers, please contact athenaeum_csc510@outlook.com. If you wish to join our mailing list for updates on our software, please email the aforementioned address and we will add you to our mailing list.
For a list of all dependencies, check out our dependencies graph. All dependencies listed are mandatory.
This project is not funded and probably never will be.