Skip to content

BloomTech-Labs/booked-up-fe

Repository files navigation

Code Climate Badge

Test Coverage

Maintainability

Booked Up

You can find the deployed project at BookedUp.net.

Documentation

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

Contributors

Christian Auld Daniel Cruz Mohammad Shafi Masoumi Derek Glynn Nathan Loveless


Project Overview

Labs PT9 Trello Board

Product Canvas

Booked up is an easy and user-friendly place for agents and authors to connect - a way for authors to post their work, a way for literary agents to leave feedback, and a one-stop location for all things connected to submitting, reviewing and communicating about written works from new authors to agents.

Key Features

  • Cloudinary image and pdf upload
  • Convenient access to authors works
  • Ability to favorite works
  • Easy and anonymous connections between author and agent

Tech Stack

React code style: prettier

Front end built using:

ReactJS

We chose this framework because

  • Familiar with React
  • Component system makes maintenance and debugging easier
  • Very active library community

axios

Material-Ui

Cloudinary

Redux

redux-thunk

Front end deployed to AWS Amplify

Back end built using:

  • Node.js
  • Postgresql
  • Express

APIs

Cloudinary

Cloudinary is an image management platform that uses REST API and has multiple integration options. Cloudinary can be managed both from the front end and/or the backend. Uploading is done through HTTPS.

Testing

Jest

-   Jest is a JavaScript Testing Framework with a focus on simplicity. It works with projects using: Babel, TypeScript, Node, React, Angular, Vue and more!

Installation Instructions

  • Fork and Clone
  • run NPM install for required dependencies
  • Currently runs on production database

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

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

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6