Restro Reviewer is a web application for reviewing and discovering restaurants. It consists of a frontend built with React and a backend built with NestJS, both using TypeScript and integrated with AWS Amplify.
- View a list of restaurants.
- View restaurant details including cuisine, location, ratings, and reviews.
- Add reviews and ratings for restaurants.
- User authentication using AWS Cognito.
- Navigate between different sections of the application.
-
Frontend:
- React with TypeScript
- React Router for navigation
- Zustand for state management
- Styled-components for styling
- AWS Amplify for authentication and backend integration
- Dockerized for consistent development and deployment
-
Backend:
- NestJS with TypeScript
- RESTful API for restaurant data
- Integration with AWS services
- Dockerized alongside frontend and database services
For more details on the technical aspects and architecture of this project, see the Technical Overview.
- Navigate to the
frontenddirectory. - Run
pnpm installto install dependencies. - Configure AWS Amplify as needed.
- Run
pnpm startto start the development server.
- Navigate to the
backenddirectory. - Run
pnpm installto install dependencies. - Run
pnpm run startto start the NestJS backend server.
The application is fully Dockerized, including the frontend, backend, and database services, ensuring a consistent development and deployment environment.
- Ensure Docker and Docker Compose are installed.
- Use
docker-compose upto start the entire stack.
The backend provides a GraphQL API for restaurant data. You can access it at http://localhost:4000/graphql.
/restaurants: Get a list of all restaurants./restaurants/:id: Get details of a specific restaurant by ID.
- Integration with cloud services for data storage and processing.
- Improved UI and user experience.
- Expansion of restaurant data and features.
Contributions to the Restro Reviewer project are welcome! Feel free to open issues or pull requests.
This project is licensed under the MIT License.