The idea of the FNDR app is to list IT agencies, who might be interested in hiring junior developers. On this platform you can filter the agencies on mutiple parameters such as location, size, etc. and find more details about the agencies that might interest you.
Here you can find a working version of the app
For this app, I created the backend in Flask. By means of an API, the frontend could GET information from the PostgresSQL database and adjust the information by POST/PATCH/DELETE.
If you would like to know more about the frontend of the FNDR app, you can take a look over here.
- Use version control (GIT) from the start of the project
- Start working with Pull Requests, after the initial setup phase
- Collaboration with issues on Github
- Use pytest
- Github Actions
- Implement CI / CD Pipeline on Heroku
- RESTful API
- DB migrations with Alembic
- Redis Cache
- Auth with JWT's
- Validation with Marshmallow
- Testing with Pytest
- File upload with AWS S3
You can find the documentation for API below:
The app was setup using a virtual environment with python 3.10. The dependencies can be found inrequirements.txt.
Run the following commandlines to setup the virtual environment and install all the dependecies.
- pip install virtualenv
- python -m venv venv
- pip install -r requirements.txt
- source venv/bin/activate
To run this project locally, you will be need to following enviroment variables:
- FLASK_APP
- FLASK_ENV
- APP_SETTINGS
- SECRET_KEY
- JWT_SECRET_KEY
- POSTGRES_USER
- POSTGRES_PW
- POSTGRES_DB
- POSTGRES_URL
- TEST_POSTGRES_USER
- TEST_POSTGRES_PW
- TEST_POSTGRES_DB
- TEST_POSTGRES_URL
- CACHE_TYPE
- CACHE_REDIS_HOST
- CACHE_REDIS_PORT
- CACHE_REDIS_DB
- CACHE_DEFAULT_TIMEOUT
- REDIS_URL
- GOOGLE_API_KEY
- Add a Google Maps feature
- File Upload for logos, using AWS S3
- Dockerize the project
I would like to thank Joanneke and Daria for their extensive work on the frontend. And of course, Rein, for all the feedback, guidance and help during this project.
