Skip to content

where-to-code/wtc-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WhereToCode Build Status

WhereToCode deployed at wWhereToCode.

Contributors

| Giacomo Benati | Nabeelah Yousuph | Basil Ogbonna | Haja Andriamaro |
Oyekunle Oloyede | | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | | | | | | | | | | | | | | | | | | |

Anuoluwapo Apiti Anubhav Bhambri - Team Lead


Project Overview

Trello Board

Product Canvas

UX Design files

Description

Finding out details about public places to work can be tedious. WhereToCode enables you to get the information you need, and only that information, to work and code on the go.

Key Features

  • Find locations around you
  • Clear information on each location for people to determine if it will work
  • New spaces are easy to make
  • Locations with most use/activity/rating show up first
  • feature five

Tech Stack

Front end built using:

React

Why did you choose this framework?

  • Scalable
  • Flexible
  • Highly performant
  • Stable

Front end deployed to https://wheretocode-frontend.herokuapp.com

WhereToCode API built using:

Node/Express

  • Express is fast.
  • Express is efficient.
  • Express is scalable.
  • Express is a lightweight framework

APIs

Authentication API here

A person can never just look at a place on the internet to determine whether or not it is a good place to post up and code. They have to go look through reviews on yelp and try to scroll through to find the information they need.

Imani is a web developer who works with a remote team. She enjoys getting out and being around people and so she is always looking to get out of the house to do so. She also has needs she needs to meet, like secure fast internet, in order to work with her coworkers. Finding this information out with 100% certainty before going somewhere is often a challenge.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

Sample * REACT_APP_GOOGLE_API_KEY - xxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxx

Content Licenses

Image Filename Source / Creator License
Homepage image Free stock Splash
rings.svg Sam Herbert MIT

Testing

Jest

  • Fast and safe
  • Easy mocking
  • Stable
  • Great API

Installation Instructions

  • Clone this repo
  • change directory to root folder

Other Scripts

To get the server running locally:

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

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 WhereToCode API for details on the backend of our project.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published