{"id":23655792,"url":"https://github.com/dssalaza/bookshelf","last_synced_at":"2026-04-12T00:38:35.534Z","repository":{"id":269997513,"uuid":"892404604","full_name":"dssalaza/BookShelf","owner":"dssalaza","description":"Simple web app to keep track of books. Add new ones, check out their details and remove them if needed. Plus I've dockerize this full-stack web application","archived":false,"fork":false,"pushed_at":"2025-01-08T20:14:38.000Z","size":68,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-19T09:14:47.627Z","etag":null,"topics":["docker","docker-compose","mongoose","react","vitejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dssalaza.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-22T03:37:20.000Z","updated_at":"2025-01-08T20:14:42.000Z","dependencies_parsed_at":"2024-12-27T18:43:43.750Z","dependency_job_id":null,"html_url":"https://github.com/dssalaza/BookShelf","commit_stats":null,"previous_names":["dssalaza/bookshelf"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dssalaza%2FBookShelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dssalaza%2FBookShelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dssalaza%2FBookShelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dssalaza%2FBookShelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dssalaza","download_url":"https://codeload.github.com/dssalaza/BookShelf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239627244,"owners_count":19670844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","mongoose","react","vitejs"],"created_at":"2024-12-28T20:15:49.331Z","updated_at":"2025-11-23T03:30:16.585Z","avatar_url":"https://github.com/dssalaza.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BOOKSHELF Project README\n\nThis project consists of two main components:\n- **Frontend (FE):** `Book-list`\n- **Backend (BE):** `Service`\n\nBoth components are designed to run locally using Docker Compose.\n\n## Prerequisites\n\nEnsure you have the following installed:\n- [Docker](https://www.docker.com/get-started)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\n## Setup and Installation\n\n### Clone the Repository\n```bash\ngit clone \u003crepository-url\u003e\ncd \u003crepository-directory\u003e\n```\n\n### File Structure\nThe project is organized as follows:\n```\n.\n├── docker-compose.yml\n├── docker-compose.debug.yml\n├── frontend/  # Contains the Book-list frontend code\n├── backend/   # Contains the Service backend code\n```\n\n### Environment Variables\n\nEnvironment variables need to be set in individial projects. Check `README.md` file of each project.\n\n## Running the Project\n\n### Start the Services\nMake sure you are running your docker daemon (docker desktop)\n\nRun the following command in the project root directory:\n```bash\ndocker-compose up\n```\nNote: If it is the first time running the project then it will take some time as the images need to be build\n\n### Access the Application\n- **Frontend (Book-list):** [http://localhost:3000](http://localhost:3000)\n- **Backend (Service):** [http://localhost:5000](http://localhost:5000)\n\n### Stopping the Services\nTo stop the services, press `Ctrl+C` or run:\n```bash\ndocker-compose down\n```\n\n## Development Notes\n\n### Frontend Development\nNavigate to the `Book-list/` directory and install dependencies:\n```bash\ncd Book-list\nnpm install\n```\nRun the development server:\n```bash\nnpm start\n```\n\n### Backend Development\nNavigate to the `Service/` directory and install dependencies:\n```bash\ncd Service\nnpm install\n```\nRun the backend server:\n```bash\nnpm run start\n```\n\n## Troubleshooting\n\n- **Ports in use:** If ports `3000` or `5000` are already in use, stop the conflicting services or update the ports in `docker-compose.yml`.\n- **Docker issues:** Ensure Docker and Docker Compose are running and up-to-date.\n\n## TODO:\nThere are a few improvements that I'd like to implement to this project:\n- [x] Improve main project README\n- [ ] Generate Swagger API documentation\n- [x] Update README for individual projects\n- [ ] Add steps to run locally without docker\n- [ ] Spin Mongo database as part of docker compose\n- [ ] Add linting\n- [ ] Add pre commit hook\n- [ ] Add Playwright tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdssalaza%2Fbookshelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdssalaza%2Fbookshelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdssalaza%2Fbookshelf/lists"}