Boun SWE 2024 Group 11

📚 About the Repository

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

⏳ Project Status

✅ Requirements + Project Planning

✅ Software Design & UI/UX Design

⏸️ Implementation

🌴 Project Structure

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.

Prerequisites

Docker

Steps

Clone the repository and change directory

git clone

cd ./bounswe2024group11

Create a .env file in the ./backend and ./frontend directories

cp backend/.env.example backend/.env
cp web/.env.example web/.env

Enter the values for the environment variables in the .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
- Docker
- Docker Compose
Run the application

cd ..
# if your containers are already running, first stop them
docker-compose down

docker-compose build
docker-compose up

📜 License

TBD

🧑🏼‍💻 Contributors

✨ Contributing

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.

bounswe / bounswe2024group11

readme