PicExchange

Image exchanging web app where you gain credits for uploading and spend them on downloading user-submitted images.

Using a system of credits, users acquire credits for uploading images to the app. In order to download an image from the app, a user must spend one of their credits. Currently all images give 1 credit for upload, and cost 1 credit to download. Uploading and downloading images requries an account, while viewing all images that have been posted is available to anyone.

This project is currently hosted at https://pic-exchange-demo.herokuapp.com/

Screenshots

Built With

• React - Framework used to design the front-end UI
• Express - Back-end web application framework
• MongoDB - Database used to store required data
• Node.js - JavaScript run-time environment
• Mocha - JavaScript testing framework
• Chai - A BDD/TDD assertion library

Development

Prerequisites

To run this application, you'll need:

• Node.js & npm installed

• A local installation of MongoDB:

  Note

  If you have brew, install MongoDB with the following steps:

  • brew tap mongodb/brew to add tap
  • brew install mongodb-community to install MongoDB
  • brew services start mongodb-community to start the MongoDB service (stop it with brew services stop mongodb-community)

The MongoDB URI, CookieKey, and Port keys can be added in a dev.js file in the ./config directory, see ./config/prod.js for an example of how to do this. There is a sample dev.js file provided, feel free to change the values in there to your liking.

Note

If you're using a local install of MongoDB then you can set the MONGO URI key to something like mongodb://localhost/my_database. You do NOT need a MongoDB account to use this local method.

Getting Started

To get the frontend and backend run locally:

• Clone this repo
• Modify ./config/dev.js if desired (see Prerequisites for details)
• npm install to install all back-end required dependencies
• cd client to navigate to front-end directory
• npm install to install all front-end required dependencies
• cd .. to return back to the root directory
• npm run dev to start the local server

The front-end will run on port 3000 to prevent conflicts with the backend Express server which runs on port 5000 (customizable using the PORT environment variable).

Testing

To run the suite of unit tests found in the /tests/ folder, simply navigate to the root directory of the project and run the command npm run test

❗ Currently only tests for Mongoose models are available. Testing for API routes is in progress.

Accessing the database API

The application provides an API in order to easily access some of the information stored on the database. The following endpoints are currently implemented:

Authentication Routes:

• POST /auth/login - sign in using username + password to an existing account
• GET /auth/logout - sign out of the currently signed in account
• GET /auth/current_user - get some basic info about currently signed in user (if any)

Image Routes:

• POST /images/upload - upload an image, store info about image in Image model and a ref to it in user model (free for image owner)
• GET /images/ - get all images for "browse" screen
• GET /images/:id/download - download the specified image
• PATCH /images/:id - update the description of the specified image (only doable by image owner)
• DEL /images/:id - delete the specified image (only doable by image owner)
• GET /images/user/:user_id - get all the images uploaded by the specified user

User Routes:

• POST /user/register - Register for a new account with this username + password
• GET /user/:user_id - Get user info of the specified user
• DEL /user/:user_id - Delete the specified user
• PATCH /user/:user_id - Update the role of the specified user

Contributing

1. Fork it (https://github.com/ErykBrol/PicExchange/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Authors

• Eryk Brol - Project Developer - ErykBrol