![Logo](https://private-user-images.githubusercontent.com/84662037/327659866-e611b1de-c188-4610-915e-0e7bfdf34de8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ2ODMyNjcsIm5iZiI6MTcyNDY4Mjk2NywicGF0aCI6Ii84NDY2MjAzNy8zMjc2NTk4NjYtZTYxMWIxZGUtYzE4OC00NjEwLTkxNWUtMGU3YmZkZjM0ZGU4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI2VDE0MzYwN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM2ZDI2MjgzNWY1ODA4MjljOWFmMjFiOTEwMjAxN2E2MDQ5ZTc5ZGE5ZTQ3MTJkZjkyOTIyZGYyZjliOWQ2OGYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Er_XD3HE39A-HBO9jx04RFzQBCZ8UxBlyQ1J8TRs_K0)
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
To get a local copy up and running follow these simple example steps.
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
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 https://localhost:3000.
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
First, clone the project repository from GitHub to your local machine.
git clone https://github.com/HE-Arc/neurona.git
cd neurona
Download and install Python from python.org.
Navigate to the project's root directory in your terminal and run the following commands:
pip install pipenv
pipenv install
pipenv shell
python manage.py migrate
Download and install PostgreSQL from PostgreSQL official site.
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;
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
}
}
Generate the database schema by running these commands:
python manage.py migrate neuronaApp
python manage.py migrate neuronaLogs --database logs
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
In the directory of the Django project, activate the virtual environment if it's not already activated and run:
python manage.py runserver
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 https://localhost:3000.
With both servers running, you can access the frontend of your application by opening https://localhost:3000 in a web browser. The backend will be accessible at https://localhost:8000.
See the RoadMap
See the open issues for a full list of proposed features (and known issues).
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!
- Fork 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.
- Nima Dekhli - github@ylked - [email protected]
- Sami Nouidri - github@lugopi - [email protected]
- Mathias Salmon - github@ClawdeenFleury - [email protected]