{"id":18308797,"url":"https://github.com/cscairney/crisp-api","last_synced_at":"2026-05-02T17:34:22.924Z","repository":{"id":203325863,"uuid":"709322028","full_name":"CSCairney/Crisp-API","owner":"CSCairney","description":"restAPI for the Crisp weather app ","archived":false,"fork":false,"pushed_at":"2024-01-22T17:23:58.000Z","size":212,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-21T17:31:34.510Z","etag":null,"topics":["express","jsonwebtoken","nodejs","postgresql","rest-api","sequelize"],"latest_commit_sha":null,"homepage":"https://crisp-api-delta.vercel.app","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/CSCairney.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":"2023-10-24T13:38:55.000Z","updated_at":"2023-10-30T12:09:57.000Z","dependencies_parsed_at":"2024-01-22T17:17:48.536Z","dependency_job_id":"7b027b0f-0345-4147-bbb0-131299f696d3","html_url":"https://github.com/CSCairney/Crisp-API","commit_stats":null,"previous_names":["cscairney/crisp-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CSCairney/Crisp-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSCairney%2FCrisp-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSCairney%2FCrisp-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSCairney%2FCrisp-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSCairney%2FCrisp-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CSCairney","download_url":"https://codeload.github.com/CSCairney/Crisp-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSCairney%2FCrisp-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278903012,"owners_count":26065784,"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-08T02:00:06.501Z","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","jsonwebtoken","nodejs","postgresql","rest-api","sequelize"],"created_at":"2024-11-05T16:09:16.602Z","updated_at":"2025-10-08T06:37:13.080Z","avatar_url":"https://github.com/CSCairney.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crisp API - RESTful API for Crisp Weather App\n\nWelcome to the Crisp API documentation! This RESTful API is built with Node.js, Express, Sequelize (as the ORM for PostgreSQL), and utilizes JWT for authentication. It serves as the backend for the Crisp weather app, allowing users to register, log in, manage blogs, retrieve user information, and handle map layers for the React Leaflet map.\n\n## Prerequisites\n\nBefore you begin, ensure you have the following installed:\n\n- **Node.js**: Download and install Node.js from [nodejs.org](https://nodejs.org/).\n- **PostgreSQL**: Set up a PostgreSQL database, you can use ElephantSQL for hosting your database.\n- **Git**: Install Git from [git-scm.com](https://git-scm.com/).\n\n## Installation\n\nTo get started, clone the Crisp API repository using the following command:\n\n```bash\ngit clone git@github.com:CSCairney/Crisp-API.git\n```\n\nThen, navigate to the project directory:\n\n```bash\ncd Crisp-API\n```\n\nInstall the dependencies using npm:\n\n```bash\nnpm install\n```\n\n## Database Configuration\nConfigure PostgreSQL: Create a PostgreSQL database on ElephantSQL and update the database configurations in config/config.json.\n\nRun Migrations: Run the Sequelize migrations to set up the database schema.\n\n```bash\nnpx sequelize-cli db:migrate\n```\n\nSeed the Database (Optional): If there are seed files available, you can run the following command to populate the database with sample data.\n\n```bash\nnpx sequelize-cli db:seed:all\n```\n\n## Usage\nStart the server using the following command:\n\n```bash\nnpm start\n```\n\nThe API will be available at http://localhost:3000.\n\n## API Routes\n### Authentication and User Management\n\"/\"\nPOST /register: Register a new user.\nPOST /login: Authenticate and generate JWT token.\n\n### Blog Management\n\"/blog/*\"\nGET /blog/:id: Retrieve information about a specific blog.\nPUT /blog/:id: Update a user's blog.\n\n### User Management\n\"/user/*\"\nGET /user/:id: Retrieve user information.\nPUT /user/:id: Update user details for the dashboard.\n\n### Map Layers Management\n\"/layers/*\"\nGET /layers/:id: Retrieve marker, polygon, and line details for the React Leaflet map.\n\n## Contributing\nContributions are welcome! Please fork the repository and submit a pull request.\n\n## Issues\nIf you encounter any issues or have questions, please create an issue on the main Crisp repository.\n\nHappy coding! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcscairney%2Fcrisp-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcscairney%2Fcrisp-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcscairney%2Fcrisp-api/lists"}