Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shivanshudwivedi authored May 7, 2024
1 parent 61cc4bc commit ddda5b7
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,23 @@ Our team consists of a diverse group of students from various backgrounds and ac
- **Database**: PostgreSQL for data storage and management.
- **Search Functionality**: Elasticsearch for advanced search capabilities.

## How to run

```bash
cd movie-bot
python MovieBot.py
```

```bash
cd movie-backend
python MovieBackend.py
```

```bash
cd ReactFrontend
npm run dev
```

## Testing Strategies

- **Backend Testing**: Comprehensive tests written for all backend functionalities to ensure reliability and stability.
Expand All @@ -45,6 +62,12 @@ Our team consists of a diverse group of students from various backgrounds and ac

To set up the application, create an `.env` file based on the `.env.example` template and fill in the `API_KEY` variable with your TMDB API access token.

## Future Goals
- Refactor code to keep consumer security & API Key security in mind.
- Improve the authentication feature & add O-Auth feature.
- Implement a Neural Network based movie recommender that suggests movies on the basis of user's previous searches.
- Deploy the application to be of public use.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

0 comments on commit ddda5b7

Please sign in to comment.