UrbanXchange is a social platform for users to browse, borrow and lend items from each other.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you how to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Using React
Following the Airbnb style guide
To run the lint, run:
npm run lint
To run the unit tests for rspec, run:
bundle exec rspec spec
To access the admin panel, simply add /admin at the end of the URL (user needs to have admin privilege).
Backend unit tests gems and their uses:
'rspec-rails' # for rails testing
'database_cleaner' # set of strategies for cleaing your database in Ruby, used after tests are run
'factory_girl_rails' # creates model objects for tests
'faker' # creates fake data to be used with FactoryGirl
Explain what these tests test and why
Give an example
Add additional notes about how to deploy this on a live system
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc