lvittor/monotion

BD2 - Monotion

In this project, we developed an API centered in a Notion-like block management system. Once logged in, the user can create, edit, and share blocks as he pleases. The app was developed in Python, using FastAPI module and Mongo as a document-oriented database that would help us in the block manipulation. There are a few considerations that will be explained in detail in the corresponding section.

Instalation

To install the app, we need to copy the repository and run the following commands in the given order

make cp-env

make build

This commands will generate the needed images to run the app

Excecution

Once all the installation is finished, to run the project you should only run the following command

make up

Take into consideration that you'll need to wait some time so that containers syncronize.

You can check the health of the containers with:

make ps

and you should obtain this same output when doing so:

'' Showing containers status...''
docker-compose -f ./docker/docker-compose.yaml ps
    Name                   Command               State                          Ports                       
------------------------------------------------------------------------------------------------------------
backend         poetry run uvicorn app.mai ...   Up       0.0.0.0:8002->80/tcp,:::8002->80/tcp              
elasticsearch   /bin/tini -- /usr/local/bi ...   Up       0.0.0.0:9200->9200/tcp,:::9200->9200/tcp, 9300/tcp
init-db         poetry run uvicorn app.mai ...   Exit 0                                                     
kibana          /bin/tini -- /usr/local/bi ...   Up       0.0.0.0:5601->5601/tcp,:::5601->5601/tcp          
mongo-express   tini -- /docker-entrypoint ...   Up       0.0.0.0:8081->8081/tcp,:::8081->8081/tcp          
mongodb         docker-entrypoint.sh mongod      Up       0.0.0.0:27017->27017/tcp,:::27017->27017/tcp      
waitfor-db      /usr/local/bin/entrypoint. ...   Exit 0                                                     

When you finish using the repo, you can remove and stop containers with:

make down

Work and considerations

Now that the project was built and is now running, we can now interact with the Swagger interface, the Mongo Express client and Kibana respectively located in localhost:8002/docs, localhost:8081 and localhost:5601.

Swagger (http://localhost:8002/docs)

Using this tool, we can interact in a more intuitive way with the API. We can now try every existing method.

For trying out the API, the credentials for pre-existing users are

[email protected]
admin

[email protected]
bot

Mongo Express Client (http://localhost:8081)

This client provides us an easy way to interact with our MongoDB instance. We can consult any collections and see how the API impacts our DB.

Kibana (http://localhost:5601)

Using this data visualizer, we can see in detail our indexes and how they were built.

The yellow health of each index is due to the lack of database replicas.

Considerations

• We decided to change the implementation proposed in the first presentation of this project, as the deletion process was not efficient and the entire collection of users was iterated when a block was trying to be deleted.
• We decided to share documents publicly instead of sharing them to a certain group of users.
• We decided not to allow all users to create a page-type block inside of another public page. Only the page owner would be the only one capable of creating a page inside an existing page.
• We decided not to impose too many restrictions to the block properties structure. While every page has a title and the other block types have text, the block will be well formed.

Requirements

• make
• docker-compose

Group members

• Leandro Ezequiel Rodriguez
• Franco Nicolas Estevez
• Lucas Agustin Vittor