pet-ads / systematic-front

Front-end for StArt tool
https://systematic-blue.vercel.app
GNU General Public License v3.0
0 stars 1 forks source link

systematic

Overview

A new, improved user interface for the StArt systematic study tool. Helps researchers easily create, develop and organize their systematic studies. Used by systematic as a front-end.

How to install and run

Systematic is being developed using the Node.js with the React framework. To run the front-end, you will need to download and install Node.js and the npm package manager that comes with it.

To work on the project, you will need an IDE (ex: VS Code. Then, you may download or clone the application and open the project there.

Following that, you must open a terminal on the folder the project is on (or click on the terminal button in your IDE), and run the following command to install the project's dependencies:

npm install

The above command must be used whenever a new dependency is added.

Now, you can use the following command to put up the webpage:

npm run dev

There! Now the front-end is up and running on http://localhost:5173. Just open that address on your browser and it should show you the running project. Make sure to keep the terminal running the server open while you use the website.

Requests

To execute requests to the back-end, you must run it as well. Instructions to do so are located on the systematic repository

Folder Structure

When working on this project, please try to follow the folder structure pointed at on the folder-structure.txt file. This allows for easy understanding of what any given file might do, and helps other developers work on the project.

License

This project is developed under the GNU GPLv3 license.

Development Team

Developed with :heart: by PET/ADS @IFSP São Carlos.