Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/achilles-dev/passco-app-backend
https://github.com/achilles-dev/passco-app-backend
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/achilles-dev/passco-app-backend
- Owner: Achilles-Dev
- Created: 2022-09-05T12:34:52.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-05T08:33:13.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T02:13:12.856Z (over 1 year ago)
- Language: Ruby
- Size: 163 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WASSCE PAST QUESTIONS APP BACKEND
> This is the backend of the WASSCE Past Questions App. It is a Rails API that serves the frontend of the app.
## Built With
- Ruby
- Ruby on Rails
- PostgreSQL
## Live Links
- [Passco app](https://passco-app-backend.herokuapp.com/)
- [API Docs](https://passco-app-backend.herokuapp.com/api-docs/index.html)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Ruby
- Ruby on Rails
- PostgreSQL
### Setup
Clone the repository
```
git clone https://github.com/Achilles-Dev/passco-app.git
```
```
cd passco-app
```
Setup the development and the test databases:
```
rails db:create
```
```
rails db:migrate
```
### Install
Install the gems:
```
bundle install
```
### Usage
To run the server use:
```
rails s
```
### Run tests
Run tests to generate the api documentation:
```
rake rswag:specs:swaggerize
```
## Authors
👤 **Solomon Hagan**
- GitHub: [@Achilles-Dev](https://github.com/Achilles-Dev/)
- Twitter: [@SoloAchilles](https://twitter.com/SoloAchilles/)
- LinkedIn: [Solomon Hagan](https://www.linkedin.com/in/solomon-hagan/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.