African Marketplace MVP

Local farmer's markets access the cloud to show off their products and increase sales

You can find the deployed project at African Market Place.

---

To demo the features use

username: demo

password: password

---

## Contributors

Rob Houck

Devon Brady

Hairo Garcia

Stephanie Enciso

Mona Hassan

Joe Park

Isaac Pak

• Fork and clone the repo to install it as your own remote.
• run: yarn install to download all dependencies.
• run: yarn start to start your local development server.

When using Okta for authentication, the app will need to run locally on port 3000.

Key Features

• Local African small businesses can register/login to site
• African businesses and visitors can see what products are being sold in their area.
• Local African small businesses can list their products

Front end deployed to vercel

Back end built using: heroku

NodeJS

• ExpressJS framework
• SQL database
• Knex ORM

Documentation

See Backend Documentation for details on the backend of our project.

APIs

user:

• /users
• /users/:id

countries:

• /countries
• /countries/:id

categories:

• /categories
• /categories/:id

items:

• /items
• /items/:id

userItems:

• /userItems/addItems
• /userItems/:id/list
• /userItems/:id/list/:id

Authentication API here

auth:

• /auth/register
• /auth/login

Installation Instructions

• git clone this repo onto your local machine
• cd into the african-market-place folder
• then run yarn install

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

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

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