This is the backend project for the Jitera assignment. It provides the API endpoints and handles the server-side logic for the application.
The project is built using the following technologies:
- Node.js: A JavaScript runtime environment
- Docker: A containerization platform
- TypeScript: A typed superset of JavaScript
- Express: A fast and minimalist web framework for Node.js
- TypeORM: An Object-Relational Mapping library for TypeScript
- PostgreSQL: A powerful open-source relational database management system
To run the project locally, make sure you have the following dependencies installed:
- Node.js: Download and Install Node.js
- Docker: Download and Install Docker
Follow these steps to get started:
- Clone the repository:
git clone cd jitera-assignment-backend
-
Install the dependencies: npm install
-
Set up the PostgreSQL database. Make sure you have a PostgreSQL server running and update the database configuration in the ormconfig.json file.
-
Start the application: npm start
The backend server will start running at http://localhost:8000.
API Documentation: The API documentation is available at /api-docs. You can access it in your browser by navigating to http://localhost:8000/api-docs. It provides detailed information about the available API endpoints, request/response schemas, and examples.
Contributing: Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
License: This project is licensed under the MIT License.