Yorubaname/YorubaNameDictionary

The Yoruba Names Dictionary # Yoruba Name Dictionary Welcome to the Yoruba Name Dictionary! This repository contains two runnable projects: a Website and an API: - The Website (yorubaname.com) interacts with the API to deliver its functionality - The API is also used by the dashboard in another repo to deliver its functionality ## Table of Contents - Projects - Prerequisites - Setup and Running Locally - Contributing - Contact Information ## Projects ### 1. Website The Website project is the end-user-facing frontend of the application that communicates with the API to deliver the service to the users. ### 2. API The API project handles the backend logic and data management, providing endpoints for the Website to consume. It uses a MongoDB database for data persistence. ## Prerequisites To run this project locally, you will need to have installed: - Visual Studio 2019 or later - Docker Desktop ## Setup and Running Locally To run the Website and API locally, follow these steps: 1. **Clone the repository:** 2. **Open the project in Visual Studio:** - Open Visual Studio. - Click on `Open a project or solution`. - Navigate to the cloned repository folder and select the `YorubaNameDictionary.sln` file. 3. **Set Docker Compose as the Startup project:** - In the Solution Explorer, locate the `docker-compose` project. - Right-click on the `docker-compose` project and select `Set as Startup Project`. 4. **Run the Docker Compose project:** - Click on the `Start` button (or press `F5`) to build and run the application. - This setup uses Docker to containerize the Website, the API and the database (MongoDB), allowing you to run and debug the application locally without manual installation of dependencies. 5. **Access the Application:** - Once the Docker containers are up and running, you can access the Website in your browser. The website should launch automatically as soon as all the containers are ready. - If the Website does not launch automatically, it will be running at `ht …