|
1 | | -# CHLOD |
| 1 | +# CHLOD (Cultural Heritage Linked Open Data) |
| 2 | + |
| 3 | +## Overview |
| 4 | +CHLOD is a structured schema based on CIDOC CRM to represent Nepal's cultural heritage data. This project facilitates standardized data representation and interoperability for cultural heritage datasets. |
| 5 | + |
| 6 | +## Getting Started |
| 7 | + |
| 8 | +### Prerequisites |
| 9 | +- [Docker](https://docs.docker.com/get-docker/) |
| 10 | +- [Docker Compose](https://docs.docker.com/compose/install/) |
| 11 | + |
| 12 | +### Running the Application |
| 13 | + |
| 14 | +1. Clone the repository: |
| 15 | + ```bash |
| 16 | + git clone <repository-url> |
| 17 | + cd chlod |
| 18 | + ``` |
| 19 | + |
| 20 | +2. Start the application using Docker Compose: |
| 21 | + ```bash |
| 22 | + docker-compose up -d |
| 23 | + ``` |
| 24 | + |
| 25 | +3. The application should now be running at: |
| 26 | + - **Frontend**: [http://localhost:3000](http://localhost:3000) |
| 27 | + - **Backend API**: [http://localhost:8000](http://localhost:8000) |
| 28 | + |
| 29 | +### Stopping the Application |
| 30 | + |
| 31 | +To stop the application and remove the containers: |
| 32 | +```bash |
| 33 | +docker-compose down |
| 34 | +``` |
| 35 | + |
| 36 | +To stop the application while preserving the containers: |
| 37 | +```bash |
| 38 | +docker-compose stop |
| 39 | +``` |
| 40 | + |
| 41 | +### Viewing Logs |
| 42 | + |
| 43 | +To view the logs of all containers: |
| 44 | +```bash |
| 45 | +docker-compose logs |
| 46 | +``` |
| 47 | + |
| 48 | +To follow the logs in real-time: |
| 49 | +```bash |
| 50 | +docker-compose logs -f |
| 51 | +``` |
| 52 | + |
| 53 | +## Accessing the Site |
| 54 | + |
| 55 | +### Frontend |
| 56 | +The frontend service is running on port 3000. You can access it by navigating to: |
| 57 | +``` |
| 58 | +http://localhost:3000 |
| 59 | +``` |
| 60 | + |
| 61 | +### Backend |
| 62 | +The backend service is running on port 8000. You can access it by navigating to: |
| 63 | +``` |
| 64 | +http://localhost:8000 |
| 65 | +``` |
| 66 | + |
| 67 | +## Docker Containers |
| 68 | + |
| 69 | +To check the status of the Docker containers, you can use the following command: |
| 70 | +```sh |
| 71 | +docker ps |
| 72 | +``` |
| 73 | + |
| 74 | +This will show you the running containers and their respective ports. |
| 75 | + |
| 76 | +## Directory Structure |
| 77 | +``` |
| 78 | +chlod/ |
| 79 | +├── docker-compose.yml # Docker Compose configuration |
| 80 | +├── backend/ # Backend API implementation |
| 81 | +├── frontend/ # Frontend application |
| 82 | +└── README.md # Project documentation |
| 83 | +``` |
| 84 | + |
| 85 | +## Contributing |
| 86 | +Contributions are welcome! To contribute: |
| 87 | +1. Fork the repository. |
| 88 | +2. Create a new branch: `git checkout -b feature-branch` |
| 89 | +3. Commit your changes: `git commit -m 'Add new feature'` |
| 90 | +4. Push to the branch: `git push origin feature-branch` |
| 91 | +5. Submit a pull request. |
| 92 | + |
| 93 | +## License |
| 94 | +This project is licensed under the MIT License. See the `LICENSE` file for details. |
| 95 | + |
| 96 | +## Contact |
| 97 | +For any inquiries, reach out via [info@cair-nepal.org](mailto:info@cair-nepal.org). |
| 98 | + |
| 99 | +## Troubleshooting |
| 100 | + |
| 101 | +### Connection Issues |
| 102 | + |
| 103 | +If you encounter connection issues, follow these steps: |
| 104 | + |
| 105 | +1. **Check Docker Container Status**: Ensure that both the frontend and backend containers are running. |
| 106 | + ```sh |
| 107 | + docker ps |
| 108 | + ``` |
| 109 | + |
| 110 | +2. **Check Container Logs**: View the logs of the frontend and backend containers to see if there are any errors. |
| 111 | + ```sh |
| 112 | + docker-compose logs frontend |
| 113 | + docker-compose logs backend |
| 114 | + ``` |
| 115 | + |
| 116 | +3. **Restart Docker Containers**: Sometimes restarting the containers can resolve the issue. |
| 117 | + ```sh |
| 118 | + docker-compose restart |
| 119 | + ``` |
| 120 | + |
| 121 | +4. **Check Network Configuration**: Ensure that your firewall or proxy settings are not blocking the connections to ports 3000 and 8000. |
0 commit comments