{"id":29895519,"url":"https://github.com/imseanconroy/cookbook","last_synced_at":"2025-10-15T09:58:55.231Z","repository":{"id":302495574,"uuid":"1006616182","full_name":"ImSeanConroy/cookbook","owner":"ImSeanConroy","description":"All your recipes in one place","archived":false,"fork":false,"pushed_at":"2025-08-28T19:54:52.000Z","size":13793,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-29T01:37:49.895Z","etag":null,"topics":["express","full-stack","nodejs","postgres","react","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ImSeanConroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2025-06-22T16:47:11.000Z","updated_at":"2025-08-28T19:54:55.000Z","dependencies_parsed_at":"2025-08-14T21:05:41.905Z","dependency_job_id":"5a1a42a8-2fab-4b93-a4fc-1d1192ca3b74","html_url":"https://github.com/ImSeanConroy/cookbook","commit_stats":null,"previous_names":["imseanconroy/cookbook"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ImSeanConroy/cookbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fcookbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fcookbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fcookbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fcookbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ImSeanConroy","download_url":"https://codeload.github.com/ImSeanConroy/cookbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ImSeanConroy%2Fcookbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279070529,"owners_count":26096840,"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","status":"online","status_checked_at":"2025-10-15T02:00:07.814Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["express","full-stack","nodejs","postgres","react","typescript"],"created_at":"2025-08-01T07:18:23.761Z","updated_at":"2025-10-15T09:58:55.226Z","avatar_url":"https://github.com/ImSeanConroy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cookbook: all your recipes in one place\n\nFullstack cookbook application built using PostgreSQL, Express, React, and Node.\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n    - [1. Prerequisites](#1-prerequisites)\n    - [2. Installation](#2-installation)\n    - [3. Frontend Setup:](#3-frontend-setup)\n    - [4. Backend \\\u0026 Database Setup:](#4-backend--database-setup)\n- [Development and Testing](#development-and-testing)\n- [Project Structure](#project-structure)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support](#support)\n\n## Getting Started\n\n### 1. Prerequisites\nBefore getting started, ensure you have the following installed:\n- [Node.js](https://nodejs.org/)\n- [npm](https://www.npmjs.com/)\n\n### 2. Installation\n\nFollow these steps to set up the application locally:\n\n1. **Clone the repository**:\n\n```bash\ngit clone https://github.com/imseanconroy/cookbook.git\ncd cookbook\n```\n\n### 3. Frontend Setup:\n\n  1. **Install Dependencies**: Navigate to the `frontend` directory and install required dependencies:\n  ```bash\n  cd frontend\n  npm install\n  ```\n\n  2. **Configure Environment Variables**: Create a `.env` file in the frontend directory with the following content:\n  ```env\n  VITE_API_BASE_URL=http://localhost:8000\n  ```\n\n  3. **Start Frontend Development Server**: Run the following command to start the frontend development server:\n  ```bash\n  npm run dev\n  ```\n\n### 4. Backend \u0026 Database Setup:\n\n  1. **Install Backend Dependencies**: Navigate to the `backend` directory and install the required dependencies:\n  ```bash\n  cd backend\n  npm install\n  ```\n\n  2. **Configure Environment Variables**: Create a `.env` file in the `backend` directory with the following content:\n  ```env\n  PORT=8000\n  NODE_ENV=development\n  READ_ONLY=false\n\n  SESSION_SECRET=example\n  SESSION_EXPIRES_IN=1d\n\n  FRONTEND_ORIGIN=http://localhost:5173\n\n  PGADMIN_DEFAULT_EMAIL=\u003cpg_admin_email\u003e\n  PGADMIN_DEFAULT_PASSWORD=\u003cpg_admin_password\u003e\n\n  POSTGRES_PASSWORD=\u003cdatabase_password\u003e\n  POSTGRES_USER=\u003cdatabase_user\u003e\n  POSTGRES_DB=\u003cdatabase_name\u003e\n  POSTGRES_PORT=5432\n  POSTGRES_HOST=localhost\n\n  DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}\n  ```\n\n  3. **Start Docker Container**: Run the following command to start the Docker container:\n  ```env\n  docker compose up -d\n  ```\n   \n  4. **Access PGAdmin**: Open your browser and go to `localhost:5050` to log in to PGAdmin using the credentials defined in the .env file. Once logged in, connect to PostgreSQL and connect to the database matching the name defined in `{POSTGRES_DB}`.\n   \n  5. **Run Database Migrations**: Use PG-migrate to set up the database tables by running:\n  ```\n  DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB} npm run migrate:up\n  ```\n\n  6. **Start Backend Development Server**: Run the following command to start the backend development server:\n  ```bash\n  npm run dev\n  ```\n\n## Development and Testing\n\nRun all backend tests with the following command:\n```bash\ncd backend\nnpm run test\n```\n\n## Project Structure\n\n```\ncookbook/\n├── frontend/                  # React application for the user interface\n├── backend/                   # Express.js server with PostgreSQL integration\n│   ├── migrations/            # Database migration files\n│   ├── test/                  # Backend tests\n│   ├── src/                   # Backend source code\n│   │   ├── config/            # Database and environment configurations\n│   │   ├── controllers/       # API request handlers\n│   │   ├── middleware/        # Request processing logic (e.g., auth, logging)\n│   │   ├── repositories/      # Database queries and schema models\n│   │   ├── routes/            # API endpoint definitions\n│   │   ├── services/          # Core business logic\n│   │   └── util/              # Utility functions (e.g., validation, logging)\n└── README.md                  # Project documentation\n```\n\n## Contributing\n\nContributions are welcome. Please open an issue or submit a pull request for any enhancements or bug fixes.\n\n## License\n\nThis project is Distributed under the MIT License - see the [LICENSE](LICENSE) file for information.\n\n## Support\n\nIf you are having problems, please let me know by [raising a new issue](https://github.com/ImSeanConroy/cookbook/issues/new/choose).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimseanconroy%2Fcookbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimseanconroy%2Fcookbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimseanconroy%2Fcookbook/lists"}