/sectors-api

Primary LanguageRuby

Ruby Rails

Sectors API

This is the backend of my react sector app.

FRONTEND project

Repository link

Quick view

Live Demo Version

sectors

Getting Started

  • Check the Ruby version or if you have at all by running ruby -v if you get something like this ruby 2.6.8p205 (2021-07-07 revision 67951) you have Ruby installed.
  • Clone the repository by running git clone git@github.com:Nyame-Wolf/Sectors-api.git in your CLI.
  • Type cd sectors-api
  • Type code .
  • Run bundle install

NOTE you need to have a master key in config directory. If none exists generate one.

  - First delete `credentials.yml.enc`
  - Run EDITOR="code" bundle exec rails credentials:edit
  • Run rails db:create db:migrate
  • Optionally you can run rails db:seed to populate it
  • Run rails server to open the local server
  • Open Browser http://localhost:4000/

API documentation

Testing

  • Run rspec

Authors

👤 Mumenya Nyamu 🧑🏻‍💻

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.