News for everyone, by anyone, from everywhere!
This time around, we decided to create an online newspaper with news from around the world, where everyone can be a potential journalist and/or editor and get paid by it! We are using a peer review approach, giving a more democratic scent to the current field of online journalism.
This was a three weeks project (May 20th - June 9th).
Check the whole design sprint and user story history of the project in this Pivotal Tracker board.
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. If you do not wish to sign up, you can use the following test credentials:
- Email: [email protected]
- Password: password
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.
The Client part of the application was acceptance tested using Cypress and component tested using Enzyme.
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. To run the component tests you can use npm run test.
Acceptance and component tests can be found in the cypress/integration and src/__tests__ folders respectively.
- 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
- Carla- GitHub Profile - Portfolio Website
- Zane- GitHub Profile - Portfolio Website
- Stefan - GitHub Profile - Portfolio Website
- Felix - GitHub Profile - Portfolio Website
- Boa - GitHub Profile - Portfolio Website
- raptorf1 - GitHub Profile - Portfolio Website
This project is licensed under the MIT license.
- PurpleBooth for this README template.
- Rails Guides for the detailed documentation.
- Stack Overflow for the guidance during the "difficult" times during development.
- React documentation for the support we needed on related issues.