https://github.com/jonjondev/myway-sinatra
The super suave Sinatra framework
https://github.com/jonjondev/myway-sinatra
api authentication datamapper framework heroku models modular myway postgresql puma rspec sinatra sinatra-controller sinatra-framework
Last synced: 3 months ago
JSON representation
The super suave Sinatra framework
- Host: GitHub
- URL: https://github.com/jonjondev/myway-sinatra
- Owner: jonjondev
- License: mit
- Created: 2017-11-19T02:13:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T13:27:26.000Z (almost 2 years ago)
- Last Synced: 2024-12-30T02:32:55.046Z (5 months ago)
- Topics: api, authentication, datamapper, framework, heroku, models, modular, myway, postgresql, puma, rspec, sinatra, sinatra-controller, sinatra-framework
- Language: Ruby
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyWay: The Sinatra framework with infinite possibilities
[](https://travis-ci.org/jonjondev/myway-sinatra)
[](https://codeclimate.com/github/jonjondev/myway-sinatra-api/maintainability)
[](https://codeclimate.com/github/jonjondev/myway-sinatra-api/test_coverage)
[](https://github.com/dwyl/esta/issues)
MyWay is a **barebones Sinatra API framework with modular boilerplates**... and it's super suave.
Its structure has been built out to be naturally quite opinionated. That being said however, the project's logic is easy enough to follow and **can easily be modified to suit your needs**.
## Getting Started
If you want to use the **MyWay CLI** integration for MyWay, you can install it with:
```bash
$ gem install myway-cli
```
and run commands with using the `myway` prefix.
You can use the CLI to generate a new project from a template with:
```bash
$ myway generate project example-project
```
Then finally have bundle installed and run it in the project directory:
```bash
$ bundle
```
Make sure you have versions of [PostgreSQL](https://www.postgresql.org) and [Redis](https://redis.io) installed as the framework uses these for model persistence and authentication tokens respectively.
## Running & Testing the Project
### Using the MyWay CLI
To get the project running at `localhost:3000` run:
```bash
$ myway run server
```
To test the project run:
```bash
$ myway run tests
```
*For more information, tips, and ticks, see the MyWay CLI gem [here](https://github.com/jonjondev/myway-cli)*
### Using the Rakefile
If you're not using the CLI, you can run any of the standard commands using the included Rakefile as follows:
```bash
$ rake run_myway
$ rake test_myway
```
## The Project Structure
```
[root]
|
|-[api]
| |-[auth]
| |-[v1] <- API files suffixed with `_api.rb`
|
|-[config] <- Configuration files for the application, models and webserver
|
|-[helpers] <- Helper files suffixed with `_helper.rb`
|
|-[models] <- Model files
|
|-[spec]
|-[auth]
|-[v1] <- Test files suffixed with `_spec.rb`
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License
This project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## To Do
* ~~Base App With Modular Controllers~~
* ~~API Boilerplate Module~~
* ~~Use Puma for Server~~
* ~~Make Heroku-Ready~~
* ~~Automatic Code Reloading~~
* ~~Controller Tests~~
* ~~Set Up Travis~~
* ~~Set Up CodeClimate~~
* ~~Add ORM~~
* ~~Add User Model~~
* ~~Create CLI~~
* ~~Add Authentication with Tokens~~
* Add Self-Documenting API