Fab labs provide widespread access to modern means for invention. They began as an outreach project from MIT’s Center for Bits and Atoms (CBA), and became into a collaborative and global network. You can find more information about Fab Labs on the Fab Foundation Website.

If you are a Fab labs entusiast and/or you would like to contribute to the project please feel free to get in touch by opening a new issue.

The platform is built with Ruby on Rails. We recommend reading the guide.

You can develop locally, or by using docker-compose (advanced).

1. Start by creating the config file and edit as needed
   • cp .env.example .env

We recommend using rbenv to handle different Ruby versions, and nvm to handle Node versions.

Install dependencies and create a database:

1. npm i

2. bundle

3. rake db:setup

4. rails s

5. Visit http://localhost:3000

Run tests with:

bundle exec rake

1. Start the project:

   docker-compose up app

2. Create database (only the first time):

   docker-compose exec app rake db:setup

   If npm does not successfully install do:

   docker-compose exec app npm i

3. Add this to your /etc/hosts:

   127.0.0.1   www.fablabs.local
   127.0.0.1   api.fablabs.local
   

4. Visit http://www.fablabs.local:3000

5. API is served on http://api.fablabs.local:3000

6. Add test users and data with

   docker-compose exec app rake db:seed

   This will create a normal user (email=[email protected], password=password) and an admin user (email=[email protected], password=password)

7. Run tests with

   docker-compose exec app rake db:setup RAILS_ENV=test

   docker-compose exec app rake spec

8. If you make changes to the code, rebuild the app and deploy the new image

   docker-compose build

   docker-compose up -d

9. Backup your db at any time with the included script:

   ./scripts/docker-backup-db.sh
   

1. Login to fablabs.io
2. Go to the developer console (on the upper-right menu)
3. Create a New application, or edit an existing one.
4. Fill in the form, Redirect URI can be 'https://example.com'
5. Submit

Copy the Personal access token

Verify the token is working with the following terminal command:

curl -X GET 'https://api.fablabs.io/0/me' -H 'Authorization: Bearer <your_personal_token>'

curl -X GET 'https://api.fablabs.io/2/labs?page=0&per_page=100'  -H 'Authorization: Bearer <your_personal_token>'

If you are running in production:

• you need to setup the SSL hosts and .env vars from the docker-compose.yml

• you must define Amazon S3 env vars, all thumbnails and images depend on this:

S3_BUCKET=your_fablabs.io
S3_KEY=<amazon key>
S3_SECRET=<amazon secret>
S3_REGION=<amazon region code>

• you need to run the assets pipeline to update public/assets

docker-compose exec app bundle exec rake tmp:clear

docker-compose exec app bundle exec rake assets:precompile

docker-compose restart app

All PRs are tested on Github Actions. Make sure the tests run.

The project is now on Crowdin https://crwd.in/fablabsio

Use the i18n-tasks normalize before submitting language changes

There is a minimal styleguide on http://localhost:3000/styleguide

Use it and update it if you add new reusable classes

Currently using this tool to manually handle versioning: https://github.com/gregorym/bump

Use this command to update the VERSION file + create a git tag

bump patch --tag

Then push the git tag with:

git push --tags

This project is licensed under the GNU Affero General Public License v3.0 (AGPL) - see the LICENSE.md file for details.