Merge pull request #41 from ProgrammingBuddies/routes

Routes

Author: petak5

.editorconfig

@@ -5,6 +5,7 @@ root = true
 indent_style = space
 end_of_line = lf
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 [*.py]
 indent_style = space

Pipfile

@@ -13,9 +13,13 @@ sqlalchemy-utils = "*"
 mysql-connector-python = "*"
 flask-dance = "*"
 pyopenssl = "*"
+flask-swagger = "*"
+flask-swagger-ui = "*"
+pytest = "*"
 flask-cors = "*"
 blinker = "*"
 flask-jwt-extended = "*"
+atomicwrites = "*"
 
 [requires]
 python_version = "3.7"

Pipfile.lock

@@ -39,6 +39,16 @@ Run the server:
 
 Your `.env` file should now look something like [example.env](https://github.com/ProgrammingBuddies/programmingbuddies-api/blob/develop/example.env)
 
+### Testing
+
+- to run multiple tests just specify the directory which contains them for example `pipenv run pytest tests/`
+- - this will run all the tests in the `tests` directory
+- if you want to run test cases only in a particular file, then just give the full file path `pipenv run pytest tests/example.py`
+
+## Milestones
+- [ ] build DB and endpoints with basic CRUD
+- [ ] add security for app (ie - bots, and non-human actors/clients)
+- [ ] add users and profile stores as well as registration/management API endpoints for users
 ## Tech stack:
 
 - Python