mphelps1978 / tally-ai-be

Tally AI Back End

Contributors

Previous Product Manager | UX Designer

Elizabeth Ter Sahakyan	Colton Mortensen	Bobby Hall	Tara Bramwell	Shanthi Madheswaran

Previous Web Development

Patrick Stevenson	Steve Renner	Daniel Firpo
David Downes	Adrian Parra	Daniel Morales
Benjamin Koehler	Raudel Flores	Mike Phelps

API Documentation

Backend delpoyed at AWS Elastic Beanstalk with Code Pipeline at http://tallyai.us-east-1.elasticbeanstalk.com/

Getting started

To get the server running locally:

• Clone this repo
• npm install to install all required dependencies
• npm start to start the local server
• npm test to start server using testing environment

TODO: Create a testing database and set up testing environment. Configure existing tests to use this environment, and write more tests.

Tech Stack

• Node / Express
• Postgres
• Knex
• JWT
• bcrypt.js
• Multer/MulterS3

Endpoints

Authentication Routes

Method	Endpoint	Access Control	Description
POST	/api/auth/register	all users	Creates a new user. Returns a token and user id.
POST	/api/auth/login	all users	Logs a user in. Returns a token and a user id.

User Routes

Method	Endpoint	Access Control	Description
GET	/users/:id	logged-in user with id	Returns user info.
PUT	/users/:id	logged-in user with id	Updates user information.
GET	/users/:id/business	logged-in user with id	Returns users owned businesses and competitors info with details from DS Table
POST	/users/:id/business	logged-in user with id	Adds business to a user's account.
POST	/users/:id/favorite	logged-in user with id	Adds competitor to a user's account.
DELETE	/users/:id/favorite	logged-in user with id	Removes competitor from a user's account.
DELETE	/users/:id/favorite	logged-in user with id	Removes competitor from a user's account.

Business Routes

Method	Endpoint	Access Control	Description
GET	business/	logged-in user with id	Returns ALL businesses
GET	/business/:id	logged-in user with id	Returns business information based on DS Business Table Information
POST	/business/:id	logged-in user with id	Calls MulterS3 Functionality in order to upload business image (Not fully implemented)

Data Model

USERS

---

{
  id: INTEGER
  first_name: TEXT
  last_name: TEXT
  email: TEXT
  password: TEXT
  preferences: JSON
  type: TEXT
  google_id: TEXT
}

Note that type and google_id are auto-populated via the Front-End Google oAuth

USERS_BUSINESSES

---

{
 id: TEXT
 user_id: INT
 business_id: TEXT

}

user_id and business_id are relational to the users table, and DS business table, respectively

USERS_COMPETITORS

---

{
 id: TEXT
 user_id: INT
 business_id: TEXT

}

user_id and business_id are relational to the users table, and DS business table, respectively

Actions

Helper Functions

Auth Helpers

• validateUser(user) -> Validates email, password, first and last name. Returns isSuccessful and errors.
• getJwtToken(email, password) -> Returns JWT.

Users Helpers

• formatUserData(user) -> Takes user info from getUserInfo(id) model function and formats data for response.
• formatBusinesses(businesses) -> Takes an array of businesses from getBusinesses(userId) or getFavorites(userId) and formats data for response.

TODO: Use formatBusinesses() in POST/DELETE endpoints for business/favorite.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables.

create a .env file that includes the following:

ENVIRONMENT=production

PORT=5000

NPM_CONFIG_UNSAFE_PERM=true

DB_PRODUCTION_HOST=**********
DB_PRODUCTION_USER=**********
DB_PRODUCTION_PW=************
DATABASE_PRODUCTION=*********
DB_PRODUCTION_PORT=**********


CLIENT_ID=**********
PROJECT_ID=*********
AUTH_URI=https://accounts.google.com/o/oauth2/auth
TOKEN_URI=https://oauth2.googleapis.com/token
AUTH_PROVIDER_x509_CERT_URL=https://www.googleapis.com/oauth2/v1/certs
CLIENT_SECRET=******
REDIRECT_URIS=http://localhost:6000/google/callback

AWS_SECRET=*****************
AWS_ACCESS_KEY_ID=**********
AWS_SECRET_ACCESS_KEY=******
AWS_IMAGE_BUCKET=tally-ai-image-store

Contributing

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.

Issue/Bug Request

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.

Feature Requests

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.

Pull Requests

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.

Pull Request Guidelines

• 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.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Frontend Documentation for details on the fronend of our project.