This is an all-in-one tool for managing data. Some key features include:
- Multiple Admins: You can have multiple admins for your data. This is useful for teams that need to manage data together.
- Data Management: You can manage your data in a variety of ways. This includes adding, editing, and deleting data.
- Data Relationships: You can create relationships between your data. This is useful for creating a network of data.
There are two ways to get started with Master EAD. You can either deploy it manually or use the Docker image method.
-
Clone the repository
git clone https://github.com/gauravjot/ead.git
-
Set up a virtual environment and activate it.
cd ./backend python3 -m venv venvLinux/MacOS
source venv/bin/activateWindows
.\venv\Scripts\activate
Install the required packages
pip install -r requirements.txt
-
Set environment variables for Django. Rename
sample.envto.envand fill in the required fields. -
Run database migrations
python manage.py makemigrations users items admins python manage.py migrate
If you encounter any issues, please refer to the Django Documentation.
-
For Production: Set up a Django production environment. Follow this guide - Deploy Django REST APIs on Ubuntu Server with uWSGI.
For Development: Run the Django server
python manage.py runserver 0.0.0.0:8000
-
Go to the
frontenddirectory and install the required packagesnpm install
-
Set environment variables for the frontend. Rename
sample.envto.envand update fields as required. -
For Production: Build the frontend
npm run build
You can then serve the static files using a web server like Nginx.
For Development: Run the frontend server
npm run dev
-
Clone the repository.
-
Edit the
deploy/backend.envanddeploy/frontend.envfiles to set the IP address on which the app will be accessible. -
Run the makefile in root directory.
make build
This will build the docker image for the project and the application will be available through port 80 of the image.
-
Run the docker container.
make run
This will run the container and the application will be available on port 8080 of the host machine. You can change the port in the
Makefile.
There are several ways you can contribute to this project:
-
Code Contributions: You can help us by writing code, fixing bugs, and implementing new features. Check out the Issues section for tasks that need attention or suggest improvements.
-
Bug Reports: If you encounter a bug while using Letsnote, please report it in the Issues section. Be sure to include relevant details that can help us reproduce the issue.
-
Feature Requests: Have an idea for a new feature? Share it with us in the Issues section. We encourage discussions around potential enhancements to the project.
This project is licensed under the MIT License - see the LICENSE.md file for details.