Welcome 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.
Before you begin, ensure you have the following installed:
- Node.js: Download and install Node.js from nodejs.org.
- PostgreSQL: Set up a PostgreSQL database, you can use ElephantSQL for hosting your database.
- Git: Install Git from git-scm.com.
To get started, clone the Crisp API repository using the following command:
git clone git@github.com:CSCairney/Crisp-API.gitThen, navigate to the project directory:
cd Crisp-APIInstall the dependencies using npm:
npm installConfigure PostgreSQL: Create a PostgreSQL database on ElephantSQL and update the database configurations in config/config.json.
Run Migrations: Run the Sequelize migrations to set up the database schema.
npx sequelize-cli db:migrateSeed the Database (Optional): If there are seed files available, you can run the following command to populate the database with sample data.
npx sequelize-cli db:seed:allStart the server using the following command:
npm startThe API will be available at http://localhost:3000.
"/" POST /register: Register a new user. POST /login: Authenticate and generate JWT token.
"/blog/*" GET /blog/:id: Retrieve information about a specific blog. PUT /blog/:id: Update a user's blog.
"/user/*" GET /user/:id: Retrieve user information. PUT /user/:id: Update user details for the dashboard.
"/layers/*" GET /layers/:id: Retrieve marker, polygon, and line details for the React Leaflet map.
Contributions are welcome! Please fork the repository and submit a pull request.
If you encounter any issues or have questions, please create an issue on the main Crisp repository.
Happy coding! 🚀