Resident Evil Characters Database

Overview

This project provides a Dockerized setup for a Resident Evil characters database. It includes a PostgreSQL database container and a simple web API using express to interact with the database.

Contents

• Setup
• Usage
• Endpoints
• Contributing
• License

Setup

1. Clone the repository:

   git clone https://github.com/your-username/resident-evil-characters.git

2. Navigate to the project directory:

   cd resident-evil-characters

3. Build and run the Docker containers:

   docker-compose up --build

   This will launch the PostgreSQL database container with express server.

Usage

Access the web API at http://localhost:3000. The PostgreSQL database is exposed on localhost:5432.

Endpoints

• GET api/char: Retrieve first 10 characters in the database and use search query to get details about specific character

Contributing

Contributions to this project are welcome! If you have improvements or additional features to suggest, feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.