Skip to content

ISPP-Grupo5/BugaLink

Repository files navigation

Contributors Stargazers


Logo

Travel together, save money, save the planet ♻️

Go to website · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contact

About The Project

Bugalink is a webapp that allows you to find other people who share the same routes as you, so you can travel The project is being developed for the ISPP subject of University of Seville.

The landing page is accessible via the bugalink.es domain. There is a link in the navigation bar that leads to app.bugalink.es where the user can access all the functionalities of the application once they have registered and logged in.

Landing page

(back to top)

Built With

  • Next
  • React
  • Django
  • PostgreSQL
  • Redis
  • Docker
  • Google cloud platform

(back to top)

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

Before working with the project, you need to have installed the following tools:

# Install python (only for local development)
sudo apt install python3
pip install --upgrade pip
pip install virtualenv

# Install docker
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

# Install npm
npm install npm@latest -g

Installation

  1. Clone the repo
git clone https://github.com/ISPP-Grupo5/BugaLink.git
  1. Set up your .env files:
# bugalink-backend/.env
SECRET_KEY="SECRET_KEY"
DEBUG=True
DATABASE_URL="postgres://{USER}:{PASSWORD}@{HOST}:{PORT}/{NAME}"

ENGINE="django.db.backends.postgresql_psycopg2"
NAME="NAME"
USER="USER"
PASSWORD="PASSWORD"
PORT="5432"
# bugalink-frontend/.env
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY='API_KEY'
NODE_ENV='development'

NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:8000
NEXT_PUBLIC_DOMAIN=http://127.0.0.1:3000
NEXTAUTH_URL=http://127.0.0.1:3000
NEXTAUTH_SECRET=SECRET_KEY
  1. Create, run and set up the backend docker containers (From the backend directory)
cd bugalink-backend

# Install the dependencies (only for local development)
pip install -r requirements.txt
pip install -r requirements-dev.txt
pre-commit install

# Start the django project and PostgreSQL-redis databases
docker-compose up --build
docker-compose exec web python manage.py migrate
docker-compose exec web python populate_db.py
  1. Run the frontend server (From the frontend directory)
cd bugalink-frontend
npm install
npm run dev

(back to top)

Contact

BugaLink - @buga_link - [email protected]

Project Link: https://github.com/ISPP-Grupo5/BugaLink

(back to top)