You can find the deployed project at https://www.findur.city
Kelly Moreira Github | Linkedin
Benjamin Quackenbush Github
Brian Leonard Github | Linkedin
Conary Beckford Github
Sean Birmingham Github | Linkedin
Alfonso Ruiz Github
Jack Kim Github
Logan Karnes Github
Zac Smith Github
Find Ur City provides city data about important factors in deciding where to live, such as:
- Population
- Average resident age
- Climate
- Median household income
- Cost of living
- Average Commute time
- and much more!
Find Ur City presents this important data in an intuitive and easy to understand interface.
- Ability to search for a city located in the US
- Customized 'Recommended Cities' list based on user's survey selections
- View detailed information about individual cities
- Ability to save your Favorite cities
This stack was used in complaince with the Labs Engineering Standards
- NodeJS
- ExpressJS
- PostgreSQL
- REST
- JWT Authentication
- Cloudinary
- bcryptjs: ^2.4.3
- cloudinary: ^1.22.0
- cors: ^2.8.5
- cross-env: ^7.0.0
- dotenv: ^8.2.0
- express: ^4.17.1
- express-fileupload: ^1.1.7-alpha.3
- express-session: ^1.17.0
- helmet: ^3.21.2
- jsonwebtoken: ^8.5.1
- knex: ^0.20.10
- knex-cleaner: ^1.3.0
- morgan: ^1.9.1
- pg: ^7.18.1
- jest: ^25.1.0
- nodemon: ^2.0.2
- supertest: ^4.0.2
Why?
- Uses Jest as the testing framework for Node
- Allows the testing of API routes
- Focus on simplicity
- Minimal configuration
Make sure you have PostgreSQL and pgAdmin4 installed on your computer.
git clone https://github.com/Lambda-School-Labs/juxta-city-data-be.git
cd juxta-city-data-be
npm install
npm run start* server - runs the app in development mode using nodemon
* start - runs the app in development mode using node
* test - runs the test watcher in an interactive mode
* coverage - generates a test coverage report
* mlt - runs knex migrate latest in testing enviroment
* mrt - runs knex migrate rollback in testing enviroment
* ml - runs knex migrate latest
* mr - runs knex migrate rollback
* srt - runs knex seed run in testing enviroment
* sr - runs knex seed run
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | / |
all users | Returns server is running confimation of Hello City. |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| POST | /api/auth/signup |
all users | Create a new user sign up. |
| POST | /api/auth/signin |
all users | Current user sign in. |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /api/users/ |
registered users | Returns info for the logged in user. |
| GET | /api/users/:id |
registered users | Returns individual user |
| PUT | /api/users/:id |
registered users | Updates individual user |
| DELETE | /api/users/:id |
registered users | Delete individual user |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /api/users/:id/favorites |
registered users | Returns favorites for an individual user. |
| POST | /api/users/:id/favorites |
registered users | Creates a favorites for an individual user. |
| DELETE | /api/users/:id/favorites/:cityId |
registered users | Deletes favorites for individual user. |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /api/profile/ |
registered users | Returns profile info for all the users that created a profile |
| GET | /api/profile/all |
registered users | Returns all the profiles and registration info |
| GET | /api/profile/:id/ |
registered users | Returns only the profile based on the user_id |
| GET | /api/profile/:id/all |
registered users | Returns the profile and registration info based on the user_id |
| POST | /api/profile/:id |
registered users | Inserts profile information based on a user id |
| PUT | /api/profile/:id |
registered users | Updates profile information based on a user id |
| DELETE | /api/profile/:id |
registered users | Deletes profile information based on a user id |
| PUT | /api/profile/:id/profile_image |
registered users | Uploads profile picture based on a user id |
| PUT | /api/profile/:id/profile_image/:cloudinary_id |
registered users | Removes profile picture based on a user id |
| Method | Endpoint | Access Control | Description |
|---|---|---|---|
| GET | /api/questions/ |
all users | Returns an array of question objects |
| GET | /api/questions/surveyobj |
all users | Returns a big object containing all th equestions and their options |
| GET | /api/questions/:id |
all users | Returns an individual question and its options by the question id |
{
"username": "ronmac",
"email": "ron@arches.com",
"password": "happymeal",
}
{
"username": "ronmac",
"password": "happymeal",
}
{
id: INCREMENT
username: STRING,
password: STRING,
email:STRING,
}
{
id: INCREMENT,
first_name: STRING,
last_name: STRING,
dob: DATE,
address: STRING,
city: STRING,
state: STRING,
zip: INTEGER,
user_id:INTEGER,
surveyinfo:JSON,
image_url: STRING,
cloudinary_id: STRING,
}
{
id: INCREMENT,
user_id: INTEGER,
city_id: INTEGER
}
{
id: INCREMENT,
question: STRING,
name: STRING
}
{
id: INCREMENT,
description: STRING,
value: STRING,
question_id:INTEGER,
}
add() Adds a new user
getBy(filter) Returns user based on filter
getById(id) Returns a single user by user ID
getAll() Returns all users
update(user, id) Updates the user
remove(id) Deletes everything dependent on the user
getProfileByUserId(id) Returns the user's profile information by user id
findProfiles(id) Finds a profile by user id
insertProfileInfo({ ...body, id }) Adds profile information for a user
updateProfileInfo(id, body) Updates profile information
deleteProfile(id) Deletes the profile information but not the user account
addImage(image, id) Adds image to the profile
deleteImage(id) Deletes image
add(favorite) Adds a new favorite to the user
get(user_id) Returns a single user by ID to retreive their favorites
getAll() Returns all favorites
remove(user_id, city_id) Returns the created org
getSurveyData() Returns an object with the survey questions and options
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Findur.City Frontend Documentation for details on the frontend of our project.