www
Universale Download WWW
TODO: Write a description here
Installation
Install postgresql and postgresql-dev and set a database. Install crystal and crystal shards. Then, use micrate and run the server :
crystal deps install
# use your credentials
echo "DATABASE_URL=postgres://root:toor@localhost/universale" > .env
psql -U postgres postgres -c "CREATE DATABASE universale"
psql -U postgres postgres -c "CREATE USER root WITH PASSWORD 'toor' SUPERUSER;"
./bin/micrate up
./db/seed.cr
./src/universale.cr
Usage
Notes
- respond to
application/json
with json objects
### Routes
- GET
/
: index - GET
/assets
:/assets/js
and/assets/css
- GET
/categories
: list the categories names and link to/categories/:name/records
- GET
/categories/:name/records
: list 100 records associated to the category. Take optionalquery parameter "offset"
- GET
/records/:id
: get informations about one specific record - POST
/records
: create a new record (required parameters:title
,data
,description
,category_id
)
Development
TODO: Write development instructions here
Contributing
- Fork it ( https://github.com/Universale/www/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
- pouleta Arthur Poulet - creator, maintainer
Repository
www
Owner
Statistic
- 0
- 0
- 0
- 0
- 3
- over 7 years ago
- August 8, 2016
License
MIT License
Links
Synced at
Thu, 07 Nov 2024 04:19:48 GMT
Languages