Skip to content

doc: improve the README.md #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pythonbrad merged 1 commit into from
May 1, 2025
Merged

doc: improve the README.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# place

![Screenshot From 2025-05-01 21-09-07](https://github.com/user-attachments/assets/d62aabeb-3c84-49a2-b12d-a0056b3a2877)

An event application for Cameroon that helps users find events based on their interests, location, and availability.

## Deployment Guide
Expand All @@ -13,7 +15,6 @@ An event application for Cameroon that helps users find events based on their in
### Setup Instructions

**Install Dependencies**
```
- **With Python:**
```sh
pip install .
Expand Down Expand Up @@ -59,7 +60,7 @@ An event application for Cameroon that helps users find events based on their in
```
- **With Docker:**
```sh
docker compose exec place-web shell -c \"import core.dummy_data\"
docker compose exec place-web ./entrypoint.sh shell -c \"import core.dummy_data\"
```

**Access the webapp**
Expand Down