Project Overview

An intuitive web platform allowing users to browse and discover scientific articles with ease. Users can filter results, view article details, including full-text in text and PDF formats, and save their favorite articles. Administrators can manage moderators and initiate uploads of scientific articles from PDF files. Subsequently, moderators can verify and correct information extracted from the PDF articles.

Getting Started

Prerequisites

• python
• pip
• mysql
• elasticsearch

Installation

1-Clone the repository.

git clone https://github.com/khaledbenmachiche/tp_igl_backend
cd tp_igl_backend

2-Install dependencies.

python -m venv env
source env/bin/activate   # On Windows, use env\Scripts\activate
pip install -r requirements.txt

Additionally, you might need to configure your database settings in the .env file and perform migrations accordingly. The format for the .env file can be found in ./ScientificArticlesSearch/.env.example.

Create a New .env File: Copy the contents of ./ScientificArticlesSearch/.env.example and create a new file named .env in the same directory.

Edit the .env File: Open the newly created .env file and update the database-related configurations with your own settings. This may include settings such as DB_NAME, DB_USER, DB_PASSWORD, DB_HOST, etc.

3-Start the development server.

cd ScientificArticlesSearch
python manage.py runserver

Unit Tests

To ensure the robustness and correctness of the application, unit tests are included. Follow these steps to run the unit tests:

1. Navigate to the Project Directory:

   cd ScientificArticlesSearch

2. Run Unit Tests

   python manage.py test

Docker support

Prerequisites

* Docker
* Docker Compose

Usage

run the Docker containers :

docker compose up --build

stopping the containers :

docker compose down

Contributing

1- Create a new branch for your feature or bug fix.

git checkout -b feature/my-feature

2- Make your changes and commit them with a clear message.

git commit -m "Add new feature"

3- Push your branch to the repository.

git push origin feature/my-feature

4- Create a pull request to the main branch of the repository.

-Remember to update the requirements.txt file with the necessary Django and other package versions used in your project.

pip freeze > requirements.txt