Welcome to the backend of the PageTalk project. PageTalk allows users to upload PDFs and receive summaries, along with query-based responses.
- ExpressJS
- TypeScript
- Docker
- Firebase Cloud Storage
- JWT: For secure header authentication and verification
- bcrypt: For password storage and retrieval
- body-parser and url-encoded: Middleware for parsing request bodies
- Users
- Query
- Admin
- Collection
- Interaction
-
User:
/user/login
(POST: Login User)/user/:username
(POST: Create User, GET: Retrieve User, PATCH: Update User)
-
Query:
/query/:pdfID
(POSGT: Create Query, GET: Retrieve Query by Username and PDF)/query/:queryID
(GET: Retrieve Query by ID, PATCH: Update Query by ID, DELETE: Delete Query by ID)
-
PDF:
/pdf/
(POST: Create PDF)/pdf/:pdfID
(GET: Retrieve PDF by ID)
To run this backend on your local machine, follow these steps:
-
Clone the repository:
git clone https://github.com/PageTalk/Backend.git
-
Configure your environment variables as in the
.env.example
file -
Change the current directory to the server:
cd server
-
Run
npm install npm start
-
Your application is now running.
- New packages can be installed through your preferred terminal using the normal
npm i
command.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Clone the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.