Skip to content

Latest commit

 

History

History
267 lines (187 loc) · 8.2 KB

README.md

File metadata and controls

267 lines (187 loc) · 8.2 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Neurona

Neurona is a dynamic exchange platform tailored for the HE-Arc community. It facilitates vibrant discussions across various topics through a structured system of spaces, posts, and comments. This document details the already existing initial specifications, giving more context and information for each task.
Explore the docs »

View Demo

About The Project

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

Clone the repository

With SSH

git clone [email protected]:HE-Arc/neurona.git

With HTTP

git clone https://github.com/HE-Arc/neurona.git

If you are working with Docker, skip to the Docker section

Docker

In a terminal in the project's current folder

docker compose up -d

Once the images have been built, the containers will launch automatically. The application is available at http://localhost:3000.

Without docker

Before you start, ensure you have the following installed on your machine:

  • Python (3.8 or later)

  • Node.js (14.x or later)

  • PostgreSQL (12.x or later)

  • Git

1. Clone the Project

First, clone the project repository from GitHub to your local machine.

git clone https://github.com/HE-Arc/neurona.git
cd neurona
2. Set Up the Backend
Install Python:

Download and install Python from python.org.

Set up a virtual environment:

Navigate to the project's root directory in your terminal and run the following commands:

pip install pipenv
Install project dependencies
pipenv install
Activate the virtual environment :
pipenv shell
Execute migrations (database must be configured, otherwise ignore):
python manage.py migrate
3. Configure PostgreSQL

Download and install PostgreSQL from PostgreSQL official site.

Create a database:

Open the PostgreSQL command line client, psql, and run:

CREATE DATABASE neuronaApp;
CREATE USER admin WITH PASSWORD 'yourpassword';
GRANT ALL PRIVILEGES ON DATABASE neuronaApp TO admin;
Configure the Django project's settings:

Open the Django project's settings file (settings.py) and configure the DATABASES setting:

    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.postgresql',
            'NAME': 'neuronaApp',
            'USER': 'admin',
            'PASSWORD': 'yourpassword',
            'HOST': 'localhost',
            'PORT': '',  # Default is 5432
        }
    }
Make Migrations

Generate the database schema by running these commands:

python manage.py migrate neuronaApp
python manage.py migrate neuronaLogs --database logs
4. Set Up the Frontend

Download and install Node.js from Node.js official site.

Navigate to the directory containing the Vue project (frontend folder) and install the necessary packages:

cd frontend
npm install
4. Run the Project
Run the Django Development Server

In the directory of the Django project, activate the virtual environment if it's not already activated and run:

python manage.py runserver
Run the Vue Development Server

Open a new command line window, navigate to the Vue project directory, and run:

npm run dev

This will start the Vite development server, usually accessible at http://localhost:3000.

5. Access the Application

With both servers running, you can access the frontend of your application by opening http://localhost:3000 in a web browser. The backend will be accessible at http://localhost:8000.

(back to top)

Roadmap

See the RoadMap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

(back to top)