Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/osamaadam/nawyish

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/osamaadam/nawyish
Owner: osamaadam
Created: 2024-02-26T20:17:26.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-03-09T13:23:57.000Z (10 months ago)
Last Synced: 2024-03-09T14:43:28.877Z (10 months ago)
Language: TypeScript
Size: 1.9 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Nawyish

## Installation

### If you trust me

1. Clone the repository.

2. `cd` into the repository.

3. Run `docker compose up -d` to start the backend and frontend.

4. Read the [mobile README](./mobile/README.md) to start the mobile app.

5. Don't read the inner READMEs. We've already formed a bond of trust. I won't let you down.

6. To stop the containers, run `docker compose down`.

The server will be running on  and the frontend will be running on .

The API documentation is available at .

On first run, the backend will seed the database so you don't have to worry about that.

> You'll notice a complete lack of auth. It's okay, don't worry about it :)

#### Here are screenshots of the running app

![apartment-listing](./screenshots/apartment-listing.jpeg)

![apartment-details](./screenshots/apartment-details.jpeg)

![apartment-listing-mobile](./screenshots/apartment-listing-mobile.jpg)

![apartment-details-mobile](./screenshots/apartment-details-mobile.jpg)

### If you don't trust me

Here are the READMEs for [backend](./backend/README.md), [web](./web/README.md), and [mobile](./mobile/README.md). Have fun with the setup!