As a group of 10 passionate people, we are building a software project to grasp various aspects of OSS (Open Source Software), collaborative development, teamwork, project management, and as well as programming. It's suggested to check the Wiki
β Requirements + Project Planning
β Software Design & UI/UX Design
βΈοΈ Implementation
Structure of the Web Part
βββ web βββ public | βββzenith-logo.png | βββzenith-logo.svg βββ src β βββ components β β βββ Button.tsx β β βββ Checkmark.tsx | | βββ ImageLink.tsx | | βββ InfoBox.tsx β β βββ InlineLink.tsx | βββ context β | βββ UserContext.tsx β βββ lib β β βββ storage.ts | βββ routes | | βββ Home.data.tsx | | βββ Home.tsx | | βββ Login.data.tsx | | βββ Login.tsx | | βββ Register.data.tsx | | βββ Register.tsx | | βββ Terms.tsx | βββ schema | | βββ search.ts | | βββ user.ts | βββ index.css | βββ main.tsx | βββ router.tsx | βββ theme.ts β βββ vite-env.d.ts
Build & Run the Application
You can follow this guide to run the whole application using Docker conainers.
Alternatively, if you want to run the backend, web, and mobile applications separately (i.e. without Docker), refer to their own READMEs.
git clone
cd ./bounswe2024group11
.env
file in the ./backend
and ./frontend
directoriescp backend/.env.example backend/.env
cp web/.env.example web/.env
.env
file.You can take the credentials for the test/deployment environment by contacting with the contributors of this repo. Or you can use your credentials for development purposes.
If you want to build this application in your local environment, you don't need to change the default .env
values after copying them from .env.example
files.
If you want to deploy this application to another host machine other than your local environment, you need to update the .env
file under ./web
directory and the settings.py
file under ./backend/config
directory.
For ./web/.env
file:
VITE_BACKEND_URL=<IP_OF_HOST_MACHINE>:8000
For ./backend/config/setting.py
file:
...
CORS_ALLOWED_ORIGINS=[
...,
"http://<IP_OF_HOST_MACHINE>:5173",
"https://<IP_OF_HOST_MACHINE>:5173",
]
Install Docker and Docker Compose
Run the application
cd ..
# if your containers are already running, first stop them
docker-compose down
docker-compose build
docker-compose up
TBD
The contributions to this repo are maintained by issues within specific templates determined under .github/ISSUE_TEMPLATE
directory. You will face a frontmatter upon pressing on the New Issue button. You can choose the template that fits your issue and fill the issue.
We do not have a PR template yet, but we plan to add one.