Introduction

Capstone-CropSwap is a RESTful API built in Express/Node.js that uses Sequelize as its ORM and Posgtres as its database manager. This app is integrated with CropSwap, which is a front-end ReactJS web application that allows users to search for, post about, and send messages regarding excess backyard garden produce. Capstone-Crop-Swap has been deployed to Heroku.

Features

• CRUD RESTful API routes for user and crop models
• Password authentication using bcrypt and JSON webtoken

Dependencies

• node.js
• express
• postgres
• sequelize
• sequelize-cli
• cors
• pg
• pg-hstore
• dotenv
• bcrypt
• jswonwebtoken
• morgan

Installation

1. Clone this repository.
2. Install dependencies by running npm install.
3. Ensure Postgres is installed on local machine.
4. Create .env file for following environmental variables: POSTGRES_DB_DEV, POSTGRES_DB_TEST, POSTGES_DB_PRODUCTION, POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_PORT (5432), POSTGRES_HOST (127.0.0.1), PORT (3000).
5. Create appropriate databases in Postgres.
6. Run npx sequelize-cli db:migrate to create Postgres tables. Reference: Sequelize Documentation.
7. Run npx sequelize-cli db:seed:all to create seed data, if desired.
8. Start server by using command npm start. Open http://localhost:3000 to view app in browser.

API Endpoints

Verb	Path	Format of Expected Request Body	Action
GET	/users optional query params: zipcode: integer, crop: text	None	Retrieves a list of users
POST	/users	{firstName: text, lastName: text, userName: text, password: text, zipcode: integer} optional key: bio: text	Creates a new user
GET	/users/username	None	Retrieves a specific user
PATCH	/users/username	{attributeToPatch: value} attributes that can be patched include: password, firstName, lastName, bio	Updates data of an existing user
GET	/users/username/crops	None	Retrieves a list of crops associated with a user
POST	/users/username/crops	{available: text, quantity: text} optional key to be used if crop is growing, instead of available: growing: text	Creates a crop associated with a user
PATCH	/users/username/crops/cropId	{available: text, quantity: text} optional key to be used if crop is growing, instead of available: growing: text	Updates a crop associated with a user
DELETE	/users/username/crops/cropId	None	Deletes a crop associated with a user
GET	/users/username/messages required query params: authUser = text	None	Gets a list of messages between a user and an authorized/logged-in user (username in query params)
POST	/users/username/messages required query params: authUser = loggedInUsername	{message: text}	Creates a message between a user and an authorized/logged-in user (username in query params)
POST	/login	{username: text, password: text}	Logs an existing user in
POST	/verified required header: token: jwt	None	Checks to see if user is already logged in