Nepali Dictionary API
A Nepali dictionary api created using Fast API and inspired from https://github.com/nirooj56/Nepdict. You can say this is just the API version of that project.
Documentation
Setting up the project locally.
Prequisities
make
makes the process automated. Make sure,make
is installed.docker-compose
anddocker
are used to bake the images and run in isolation. This also helps you from not requiring psql, pgadmin installed in your machine.
Steps
-
Clone the repository.
-
Make sure to override
.env
file to add your own variables.cp .env.local .env $EDITOR .env
-
Run the project using the following command.
make dev
-
If you're running for the first time, you may want to run migrations with the command.
make migrate
-
If you want to seed the database using the currently provided data, run the following command.
make seed-db
-
The development service will be live: http://localhost:8000
-
PGAdmin will be available on: http://localhost:5000
Credits
- Architecture Inspired from @robusgauli