Git Product home page Git Product logo

being_stockholm-api's Introduction

Coverage Status Build Status

Project Title

Being Stockholm !

Being Stockholm engages citizens to digitally share, map and illustrate how they use the region. Residents shares geotagged photos of how they work and play along with a short caption, so we can produce:

  • A data point map to illustrate where Stockholmers work and play
  • A word cloud map to describe how Stockholmers work and play
  • A curated map of recommendations by Stockholmers for Stockholmers

We want to inspire residents to explore new parts of the city and try out activities. Everyone can share their experiences, regardless of how long they have lived in Stockholm and their language.

We can help urban planners see how the city is used and changing, so that the urban development process can be more responsive, and even change the perceptions of regeneration areas, to attract new and established Stockholmers alike.

Companies can attract and retain internationals with a preview of living and working in Stockholm. It can be part of their post-relocation care to help the new staff, their partner and family feel more settled to reduce the risk of their relocation ending prematurely.

Active and engaged residents will help Stockholm remain as a top city to live and work, attract internationals to keep Sweden competitive, and a platform to promote Sweden to the world.

This is an actual project that we were offered the chance to develop as our final project with Craft Academy. Our goal is to build a Minimum Viable Product, which means there is lots of space for improvements.

This was a three weeks project (June 10th - June 28th).

User Stories

Check the whole design sprint and user story history of the project in this Pivotal Tracker board.

Deployment & GitHub

This application consists of a back-end API and a front-end Client.

The GitHub repository for the API is here and the one for the Client is here.

The API is deployed using Heroku on this address.

The client, which is where everything happens, is deployed via Netlify here.

Tests, Test Coverage & CI

API

The API part of the application was request and unit tested using Rspec.

To be able to run the tests, run bundle install in your terminal as soon as you fork this repository.

You must also have the database migrations in place, in order for everything to work properly. So in your terminal run rails db:migrate. In case this command produces an error, you can run rails db:drop db:setup.

After that, use bundle exec rspec to run all tests avoiding any conflicts with the gems of this repo and your locally installed gems.

Unit and request tests can be found in the spec/models and spec/requests folders respectively.

Coveralls was used to measure the API's test coverage.

Semaphore CI was used for continious integration.

CLIENT

The Client part of the application was acceptance tested using Cypress.

To be able to run the tests, run npm install in your terminal as soon as you fork this repository.

After that, use npm run cy:open to launch a local server instance of the application and run all acceptance tests of Cypress.

Acceptance tests can be found in the cypress/integration folder.

Built With

  • API with Ruby on Rails version 5.2.3.
  • API with Ruby version 2.4.1.
  • Client with React.
  • Client was styled using Semantic UI.
  • Client uses theming functionality of Semantic-UI precompiled with gulp. All relevant files can be found in src/semantic folder.

Authors

License

This project is licensed under the MIT license.

Acknowledgments

being_stockholm-api's People

Contributors

zanenkn avatar carrosen avatar raptorf1 avatar leiter007 avatar stefankarlberg avatar oliverochman avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.