Skip to content

Commit

Permalink
Updated README coinciding with updated Project Structure Wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
DeepBlockDeepak committed Dec 8, 2023
1 parent ff1d8e8 commit 35a4a6a
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 6 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,3 @@
- Ensure that your code adheres to the project's coding standards and passes all checks.
- When adding new dependencies, update `pyproject.toml` using `poetry add <dependency>`.
- Use `poetry update` to update dependencies and `poetry lock --no-update` to regenerate the lock file without updating dependencies.

Thank you for contributing to the Travel App project!
61 changes: 57 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,57 @@
## TO RUN & TEST LOCALLY ON UNIX
* 1.) Download the zipfile and unzip it in your local folder.
* 2.) If it's your machine's first time running this project, install Poetry following the instructions from [Poetry's official website](https://python-poetry.org/docs/#installation). Then, navigate to the project's root directory and run `poetry install` to set up the project's virtual environment and install necessary packages.
* 3.) To bootstrap/reset the database, run `poetry run python add_db_data.py`. After setting up the database, start the application with `poetry run python main.py`. Access the app by navigating to the provided URL in your web browser.
# Travel App

## Introduction
Interactive web application for planning road trips, offering information on destinations, activities, cost estimates, and user-specific journey insights. Features secure user profiles for personalized trip planning.

## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites
- Python 3.x
- [Poetry](https://python-poetry.org/docs/#installation) for dependency management

### Installation
1. Clone the repository or download the ZIP file and extract it.
2. Navigate to the project's root directory.
3. Install dependencies using Poetry:
```bash
poetry install
```


### Setting Up the Database
To completely reset the database, use the provided script:
```bash
poetry run python scripts/add_db_data.py
```


### Running the Application
Start the application with the following command:
```bash
poetry run python run.py
```

Access the app by navigating to `http://127.0.0.1:5000/` in your web browser.

## Testing
Run the tests using the following command:
```bash
poetry run pytest
```


## Project Structure
A brief overview of the project structure is as follows:

- `app/`: The Flask application and its modules.
- `scripts/`: Utility scripts for database and other tasks.
- `tests/`: Test cases for the application.

For a detailed explanation of the project structure, please refer to the [App Project Structure Wiki](https://github.com/DeepBlockDeepak/RoadTripPlanner/wiki/Database-Schema-Documentation).


## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.


0 comments on commit 35a4a6a

Please sign in to comment.