Freelance API

Make your freelancing more efficient by managing leads, proposals, project documents, clients and more.

This is a work in progress.

Getting Started

Prerequisites

Ruby ~> 2.4

Download and manage via rbenv or RVM

Rails ~> 5.1

gem install rails -v '~> 5.1'

PostgreSQL ~> 9.6

Follow the instructions for downloading PostgreSQL based on your operating system, and be sure to create a database user with privileges.

Installing

Clone the repository:

git clone https://github.com/chznbaum/freelance-api.git
cd ./freelance-api

Install the gems:

bundle install

And set up the database:

rails db:create
rails db:migrate

Start the development server:

rails s

You can test this by making a GET request to localhost:3000 using Postman or an alternative.

Tests

End to End Tests

TBA

Coding Style Tests

TBA

Deployment

TBA

Built With

• Rails - Web Framework
• rbenv - Environment Managemet
• Bundler - Dependency Management
• Heroku - Deployment Platform
• Travis CI - Continuous Integration

Contributing

Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.

Versioning

TBA

Authors

• Chazona Baum - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for more details.

Acknowledgements