diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ac2790c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ + +## [cssi-api-0.1a1](https://github.com/brionmario/cssi-api/compare/682caa54ed2c92a89b5377fd664e9e6bfeb93037...cssi-api-0.1a1) (2019-05-22) + +### Bug Fixes +- **app:** fix table recognition issue in migration :bug: ([42bda1a](https://github.com/brionmario/cssi-api/commit/42bda1ab496b940115e1a5868462496bb921db38)) +- **models:** fix data type issues in models :bug: ([53b521c](https://github.com/brionmario/cssi-api/commit/53b521cef7201af70994b9d25e33256f4045dd85)) +- **models:** fix minor validation issues in models ([56b39e6](https://github.com/brionmario/cssi-api/commit/56b39e69794eb9be68e0c9d092fca9a44fd745a4)) + +### Code Refactoring +- **app:** change folder structure :truck: ([77e49ae](https://github.com/brionmario/cssi-api/commit/77e49ae727da0c90da9029961d539eb7e8f2212c)) +- **app:** move routes to v1 folder :truck: ([a2f368f](https://github.com/brionmario/cssi-api/commit/a2f368f1807ad4f4e5bc00edf88c5fe1985cb53c)) +- **app:** remove flask restful code dependencies :recycle: ([1d97108](https://github.com/brionmario/cssi-api/commit/1d97108dedd7c16697271ee54076944e0ffbf349)) +- **app:** rename applications to application :truck: ([33fcbdb](https://github.com/brionmario/cssi-api/commit/33fcbdbc7400605b9eef195f56ebc083bc0526c3)) +- **config:** move app config to new folder :truck: ([46e6b17](https://github.com/brionmario/cssi-api/commit/46e6b17c3a88be2037942aa94bea4e5ee7980011)) +- **core:** refactor entire codebase :recycle: ([5f772de](https://github.com/brionmario/cssi-api/commit/5f772de4db0e0c97c1ab66abde1b7bed54226078)) +- **core:** remove base run script :fire: ([f0f0a8c](https://github.com/brionmario/cssi-api/commit/f0f0a8c42ce9dad58481a5aef94d31e323f5eca3)) +- **events:** modify celery task init logic ([614658a](https://github.com/brionmario/cssi-api/commit/614658abdfdd5e8dc325f4bdd8a6b810b968e65e)) +- **events:** move celery tasks to a separate file :truck: ([1a21a62](https://github.com/brionmario/cssi-api/commit/1a21a621c0d2bc855ddad9dd504cffe5112cce1b)) +- **models:** put models in separate files :recycle: ([d1102c6](https://github.com/brionmario/cssi-api/commit/d1102c61260e5893ce96f80a67e9d36ad7f493b7)) +- **models:** refactor application models and schemas ([a2f7a8e](https://github.com/brionmario/cssi-api/commit/a2f7a8ea831ce962193c9a312f093c8c2cdd7f2e)) +- **routes:** refactor application routes ([bd0b739](https://github.com/brionmario/cssi-api/commit/bd0b73953bcf1054a4f3f9ed00616b7ac2dfec14)) +- **routes:** remove initial validation in application GET ([e7d2a4d](https://github.com/brionmario/cssi-api/commit/e7d2a4d5d8a2509134a3b0f3142659066d4f1771)) +- **routes:** remove unwanted imports ([964c509](https://github.com/brionmario/cssi-api/commit/964c509830f5b631dd5eb930c7c3ce3433813d59)) + +### Features +- **core:** add cors support :sparkles: ([f40a075](https://github.com/brionmario/cssi-api/commit/f40a07575bf64790f6ab0da56abe0282b2868064)) +- **core:** add logging support :sparkles: ([e2d7641](https://github.com/brionmario/cssi-api/commit/e2d76418fa8d7b30837b254424ff77c18c35d44c)) +- **core:** add plugin support :sparkles: ([e45efa9](https://github.com/brionmario/cssi-api/commit/e45efa9de906cd7c44c2da75e367d5cb0af44fb3)) +- **core:** add websocket support :sparkles: ([fdfbfe0](https://github.com/brionmario/cssi-api/commit/fdfbfe05e315a5c3b109a269bc077d904594ce22)) +- **core:** implement sessions related functionality :sparkes: ([97392b3](https://github.com/brionmario/cssi-api/commit/97392b3937410197a98cd0c33d8bca4468155ee8)) +- **sessions:** add session status recording ability :sparkles: ([d23ff41](https://github.com/brionmario/cssi-api/commit/d23ff411cd1aec18bade6609cc8b3304813caa69)) +- **views:** implement basic application routes :sparkles: ([9de44ea](https://github.com/brionmario/cssi-api/commit/9de44eae0b6fb5a34c9529dd1be483a9b2e97676)) + + diff --git a/LICENSE.txt b/LICENSE.md similarity index 100% rename from LICENSE.txt rename to LICENSE.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cacf173 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +

+ logo-text +

RESTful API for the CSSI Platform

+

+ + +

+ + + License: MIT + +

+ +# Getting Started + +```bash +# clone the repository +git clone https://github.com/project-cssi/cssi-api.git + +# change the directory +cd cssi-api + +# install the dependencies +pip install -r requirements.txt + +# create the database +python manage.py recreate_db + +# add metadata to database +python manage.py create_metadata + +# fire up redis server +redis-server + +# start celery workers +python manage.py celery + +# run the app +python manage.py runserver + +``` + +# Built With + +python   +flask   +redux   +lodash   +celery   +marshmallow   +sass   +redis   + +# Changelog + +Please refer [CHANGELOG.md](CHANGELOG.md) to learn about the latest improvements, breaking changes and bug fixes. + +# Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines and to learn about our code of conduct. + +# License + +[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api?ref=badge_large) diff --git a/README.rst b/README.rst deleted file mode 100644 index 599547b..0000000 --- a/README.rst +++ /dev/null @@ -1,5 +0,0 @@ -=========== -CSSI REST API -=========== - -REST API for the CSSI library \ No newline at end of file diff --git a/docs/logos/cssi-logo square-pixel.png b/docs/logos/cssi-logo square-pixel.png new file mode 100644 index 0000000..fadf32e Binary files /dev/null and b/docs/logos/cssi-logo square-pixel.png differ diff --git a/docs/logos/cssi-logo-black.svg b/docs/logos/cssi-logo-black.svg new file mode 100644 index 0000000..ff26132 --- /dev/null +++ b/docs/logos/cssi-logo-black.svg @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-core.png b/docs/logos/cssi-logo-core.png new file mode 100644 index 0000000..8cbc787 Binary files /dev/null and b/docs/logos/cssi-logo-core.png differ diff --git a/docs/logos/cssi-logo-dashboard-text-only-white.svg b/docs/logos/cssi-logo-dashboard-text-only-white.svg new file mode 100644 index 0000000..1b5acf1 --- /dev/null +++ b/docs/logos/cssi-logo-dashboard-text-only-white.svg @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-dashboard.png b/docs/logos/cssi-logo-dashboard.png new file mode 100644 index 0000000..50288ac Binary files /dev/null and b/docs/logos/cssi-logo-dashboard.png differ diff --git a/docs/logos/cssi-logo-dashboard.svg b/docs/logos/cssi-logo-dashboard.svg new file mode 100644 index 0000000..a449825 --- /dev/null +++ b/docs/logos/cssi-logo-dashboard.svg @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-outline.svg b/docs/logos/cssi-logo-outline.svg new file mode 100644 index 0000000..debf6ff --- /dev/null +++ b/docs/logos/cssi-logo-outline.svg @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-rest-api.png b/docs/logos/cssi-logo-rest-api.png new file mode 100644 index 0000000..c2bd379 Binary files /dev/null and b/docs/logos/cssi-logo-rest-api.png differ diff --git a/docs/logos/cssi-logo-rest-api.svg b/docs/logos/cssi-logo-rest-api.svg new file mode 100644 index 0000000..87c573d --- /dev/null +++ b/docs/logos/cssi-logo-rest-api.svg @@ -0,0 +1,86 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-square.png b/docs/logos/cssi-logo-square.png new file mode 100644 index 0000000..0be33f6 Binary files /dev/null and b/docs/logos/cssi-logo-square.png differ diff --git a/docs/logos/cssi-logo-square.svg b/docs/logos/cssi-logo-square.svg new file mode 100644 index 0000000..a8e9390 --- /dev/null +++ b/docs/logos/cssi-logo-square.svg @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo-text-only.png b/docs/logos/cssi-logo-text-only.png new file mode 100644 index 0000000..c5959e2 Binary files /dev/null and b/docs/logos/cssi-logo-text-only.png differ diff --git a/docs/logos/cssi-logo-white.svg b/docs/logos/cssi-logo-white.svg new file mode 100644 index 0000000..f3fdbff --- /dev/null +++ b/docs/logos/cssi-logo-white.svg @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logos/cssi-logo.png b/docs/logos/cssi-logo.png new file mode 100644 index 0000000..4be3219 Binary files /dev/null and b/docs/logos/cssi-logo.png differ diff --git a/docs/logos/cssi-logo.svg b/docs/logos/cssi-logo.svg new file mode 100644 index 0000000..19babe5 --- /dev/null +++ b/docs/logos/cssi-logo.svg @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/technologies/celery.png b/docs/technologies/celery.png new file mode 100644 index 0000000..4a5bdc7 Binary files /dev/null and b/docs/technologies/celery.png differ diff --git a/docs/technologies/flask-socketio.png b/docs/technologies/flask-socketio.png new file mode 100644 index 0000000..6f91103 Binary files /dev/null and b/docs/technologies/flask-socketio.png differ diff --git a/docs/technologies/flask-sqlalchemy.png b/docs/technologies/flask-sqlalchemy.png new file mode 100644 index 0000000..c4c24ec Binary files /dev/null and b/docs/technologies/flask-sqlalchemy.png differ diff --git a/docs/technologies/flask.svg b/docs/technologies/flask.svg new file mode 100644 index 0000000..9e7a839 --- /dev/null +++ b/docs/technologies/flask.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/technologies/marshmallow.png b/docs/technologies/marshmallow.png new file mode 100644 index 0000000..1996177 Binary files /dev/null and b/docs/technologies/marshmallow.png differ diff --git a/docs/technologies/mysql.svg b/docs/technologies/mysql.svg new file mode 100644 index 0000000..557da75 --- /dev/null +++ b/docs/technologies/mysql.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/technologies/python.svg b/docs/technologies/python.svg new file mode 100644 index 0000000..366f52f --- /dev/null +++ b/docs/technologies/python.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/docs/technologies/redis.png b/docs/technologies/redis.png new file mode 100644 index 0000000..de2f2ec Binary files /dev/null and b/docs/technologies/redis.png differ