bin/setup
- install required packages and gems locally and prepare DB
bin/server
- to run server locally
bin/tests
- runs RSpec tests
bin/quality
- runs quality tools
bin/docker-setup
- build Docker image and prepare DB
bin/docker-server
- to run server locally via Docker
bin/docker-tests
- runs RSpec tests via Docker
bin/docker-quality
- runs quality tools via Docker
bin/docker-sync
- install docker-sync library to speed up performance on Mac OSX
GraphQL query base path
https://rails-base-graphql-api.herokuapp.com/graphql
# query
mutation SignUp($input: SignupInput!) {
signup(input: $input) {
me {
id
email
}
accessToken
refreshToken
}
}
{ "input": { "email": "john.tolkien@example.com", "password": "654321", "firstName": "John", "lastName": "Tolkien" } }
3. Use this token to send the following requests. Token sent to the "Authorization" in the header
#### Header example
```ruby
Authorization: Bearer <token>
git clone git://github.com/fs/rails-base-graphql-api.git --origin rails-base-graphql-api [MY-NEW-PROJECT]
Create your new repo on GitHub and push master into it. Make sure master branch is tracking origin repo.
git remote add origin git@github.com:[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
git push -u origin master
bin/docker-sync
bin/setup
or if you'd like to use Docker:
bin/docker-setup
bin/tests
bin/quality
or with Docker:
bin/docker-tests
bin/docker-quality
bin/server
or
bin/docker-server
Run rails c
console:
docker-compose exec app bin/rails c
Connect to postgres:
docker-compose exec app bin/rails db # password: "password"
View Rails logs:
docker-compose logs app
We use Github Packages to store docker images. To use them you need to create Personal Access Token with the appropriate scopes(read_packages - to download images, write_packages - to upload). Authenticate to GitHub Packages with docker using docker login
command:
cat ~/TOKEN.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin
where TOKEN.txt
- file with personal access token and USERNAME
- your GitHub username
After that you can download docker image with the docker pull
command:
docker pull docker.pkg.github.com/fs/rails-base-graphql-api/final:TAG_NAME
where TAG_NAME
- name of the branch
To upload docker image use docker push
command:
docker push docker.pkg.github.com/fs/rails-base-graphql-api/final:TAG_NAME
More details about image uploading you can find at GitHup Packages docs
To use GitHub Packages on Semaphore CI you can store Personal Access Token as the secret. After that add it to your .semaphore.yml
config:
secrets:
- name: github-docker-secrets