https://github.com/clairezed/la-fabrique
Tool participatory directory - Répertoire participatif d'outils thématiques
https://github.com/clairezed/la-fabrique
postgresql rails5
Last synced: about 2 months ago
JSON representation
Tool participatory directory - Répertoire participatif d'outils thématiques
- Host: GitHub
- URL: https://github.com/clairezed/la-fabrique
- Owner: clairezed
- License: agpl-3.0
- Created: 2017-02-17T14:26:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-03-18T21:28:36.000Z (over 5 years ago)
- Last Synced: 2025-07-18T11:45:02.346Z (12 months ago)
- Topics: postgresql, rails5
- Language: Ruby
- Homepage: https://www.lafabriquedumonde.fr/
- Size: 1.57 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# La fabrique
Digital toolbox gathering tools, methods, media contents to foster projects.
## Getting Started
*These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.*
### Prerequisites
- ruby 2.4.0
- rails 5.0.1
- postgresql
### Installing
```bash
git clone git@github.com:clairezed/la-fabrique.git
cd la-fabrique
bundle install
cp config/database_example.yml config/database.yml
# Update database.yml to cope with your own database connection credentials
bin/rake db:setup
bin/rake db:seed
rails server
```
Your website should be accessible at [localhost:3000](http://localhost:3000/).
Email notifications will be caught by [MailCatcher](https://mailcatcher.me/). Install it if you haven't yet.
Then, to see the emails sent by the platform, open your web browser at http://localhost:1080 to access the MailCatcher interface.
### Dummy data
If you want to generate 20 fake lightweight tools, you can run :
```bash
rake seeds:dummy_tools
```
## Running the tests
```bash
RAILS_ENV=test rake db:setup
RAILS_ENV=test bin/rake db:seed
rspec
```
The project could clearly have more tests. Don't hesitate to contribute, I'll be happy to help !
## Deployment
Deployment successfully tested on servers with :
- ubuntu LTS 16.04
- nginx
Capistrano is used.
You have to copy and update a few files :
```
cp config/database_example.yml config/database_production.yml
cp config/deploy_secrets.yml.example config/deploy_secrets.yml
```
## Built With
* [Bootstrap4](https://v4-alpha.getbootstrap.com/getting-started/introduction/) - alpha6
## Contributing
*Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.*
-> TODO
## Authors
* Development, integration : **Claire Zuliani** - [github account](https://github.com/clairezed) - [website](http://www.clairezuliani.com/)
* Design : **Phi²** - [website](http://phicarre.fr/)
## License
This project is licensed under the AGPL 3.0 License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
- back office inspired by [Modular Admin](https://github.com/modularcode/modular-admin-html)
### end writing open source docs
- Open source license : MIT, Apache 2.0, and GPLv3
- README :
- What does this project do?
- Why is this project useful?
- How do I get started?
- Where can I get more help, if I need it?
- Contributing guidelines
- How to file a bug report (try using issue and pull request templates)
- How to suggest a new feature
- How to set up your environment and run tests
- Code of conduct