https://github.com/hutusi/bookshare
An opensource bookcrossing app.
https://github.com/hutusi/bookshare
api-server ruby ruby-on-rails
Last synced: over 1 year ago
JSON representation
An opensource bookcrossing app.
- Host: GitHub
- URL: https://github.com/hutusi/bookshare
- Owner: hutusi
- Created: 2019-10-01T16:07:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T19:38:11.000Z (over 3 years ago)
- Last Synced: 2025-02-28T12:20:15.919Z (over 1 year ago)
- Topics: api-server, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://zhimaishu.com
- Size: 820 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Bookshare
Bookshare app server.
## Deployment
[Deployment guide](deploy.md)
## Development
* Ruby >= 2.6
* Node, yarn
* PostgreSQL
* Redis
### MacOS
PostgreSQL:
```sh
brew install postgresql
brew services start postgresql
createuser --createdb bookshare
```
Redis:
```sh
brew install redis
brew services start redis
redis-cli ping
```
### Bundle install & migrate
```sh
bundle
bundle exec rails db:setup
bundle exec rails db:migrate
```
### Start server
```sh
bundle exec rails s
```
or
```sh
foreman start
```
### Testing
Run rspec tests:
```sh
rspec
```
Run rubocop:
```sh
rubocop
```
or:
```sh
guard
```
## Changelogs
[CHANGELOG.md](CHANGELOG.md)
## TODO
- [ ] Refine sidekiq
- [ ] Caching queries
- [ ] API: search
- [X] Remove unused code
- [ ] Rspec test cover
- [ ] CI enabled
- [X] Backup database
- [X] Use Pundit instead of cancancan
- [ ] Limits creating sharing
- [ ] Validates models, rspec models
- [ ] Tailwind css