Web app for modeling navy systems: create systems, upload SysML/CSV data, visualize as graphs, and export to SysML. Built with Django (backend), React (frontend), and PostgreSQL.
Documentation: See docs/PROJECT_OVERVIEW.md for a high-level overview of tools, languages, and architecture. See docs/REFACTORING_AND_DOCS.md for a refactoring and documentation plan to make new features easier to add. Ethernet simulation details live in docs/ETHERNET_SIMULATION.md.
- Node.js: can be installed here
Make sure you are in the Views folder, can be achieved using
cd Views
First time running, make sure you have the node modules installed
npm i
To run the actual app:
npm run dev
Login credentials:
- Username: example
- Password: 123456 Note: in Docker, this user is created automatically. For local dev, use Sign Up if the user doesn't exist.
Please watch this video to understand how django rest framework works.
Python: can be installed here
STRONGLY RECOMMENDED: Use a virtual environment to install the required packages. You can install it by running the following command (note, for macbook, you may need to use `python3` instead of `python`):
python -m venv env
Wait for the environment to be created, then activate it by running the following command:
On Mac:
source env/bin/activate
On Windows:
.\env\Scripts\activate
After you have activated the virtual environment, you should see (env) in the terminal.
Install the required packages by running the following command:
pip install -r requirements.txt
Make sure you are in the Services folder, can be achieved using
cd Services
Run the server by running the following command:
python manage.py runserver
Making migrations (every time you change the models):
python manage.py makemigrations
python manage.py migrate