Nitay880 / Zulu

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Zulu app

License: MIT

About the app

A Local exploration App

A social platform that allows viewing stories based on geographical location

  • A local social app where people can share (anonymously or otherwise) personal histories attached to specific locations. Ranging from historical tidbits and recommendations to personal stories about life events or emotions connected to this location.
  • Users can become tourists in familiar locations, viewing the world through other's eyes, as well as a more intimate peak into
  • main interface is a map of local stories.
    • Maybe only the immediate surroundings can be seen?

Current status

The application is in early development stage, right now you can run:

  • The backend, based on Python/FastAPI/MongoDB
  • The frontend, based on React
  • Deployment based on Docker/Docker-compose

There is still no connectivity between the two.

Running Zulu locally

  1. Make sure you have docker-compose installed on Linux
  2. Clone this project:
    git clone https://github.com/OSS-team-zulu/Zulu.git
    cd Zulu
  3. Bring up the services using docker-compose:
    docker-compose up
  4. Web UI: http://localhost:8085, Backend API: http://localhost:8086/docs

Contributing

This project is under the MIT License

Bugs

If you hit a bug - open an issue under this repository.

Contributing code

Code contributions are welcomed!

First, read our guidelines at Backend and Frontend in order to setup a development environment.

Afterwards:

  1. Fork this repository
  2. Apply your code changes in your forked branch
  3. Open a pull request

Project & Team Info

Tracking tasks

  1. Tasks are tracked using GitHub issues
  2. We use GitHub Kanban board for planning - https://github.com/OSS-team-zulu/Zulu/projects/1

Contributors

About

License:MIT License


Languages

Language:Python 63.6%Language:HTML 14.4%Language:JavaScript 10.4%Language:Dockerfile 6.5%Language:CSS 5.1%