Skip to content

Document libraries used in the readme #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrcarretas merged 1 commit into from
Nov 27, 2024
Merged

Document libraries used in the readme #525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@

This is a web map that helps explore Indigenous language data. This README file includes new materials added in Milestones 3 and 2 of this project. [See Milestone 1 deliverables here](./README-MILESTONE1.md).

## Technology Stack Overview

- Fully Dockerized, and configured with docker-compose.
- Uses PostgreSQL and PostGIS.
- API-Driven Django. We don't use Django's templates for anything.
- Uses Nuxt.js for SEO-friendly modern templates.
- Proxies all ports through port 80, the default, including websockets, so there's no need to worry about the port of anything when developing.

## Installation

Clone the project.
Expand Down Expand Up @@ -349,3 +341,19 @@ docker-compose exec web python manage.py test_notifications --email <email of us
```

Specifying a number days (integer) will always force-send updates the specified number of days of updates, regardless of whether those updates have already been sent.

## Technology Stack Overview

- Fully Dockerized, and configured with docker-compose.
- Uses PostgreSQL and PostGIS.
- API-Driven Django. We don't use Django's templates for anything.
- Uses Nuxt.js for SEO-friendly modern templates.
- Proxies all ports through port 80, the default, including websockets, so there's no need to worry about the port of anything when developing.

### Relevant Backend Libraries
- Authentication - [Cognito JWT](https://pypi.org/project/cognitojwt/)
- APIs - [Django Rest Framework](https://www.django-rest-framework.org/)
- GIS - [GeoJSON](https://pypi.org/project/geojson/)
- Linting - [Pylint](https://pypi.org/project/pylint/)
- Testing Coverage - [Coverage](https://coverage.readthedocs.io/)
- API documentation - [DRF YASG (Swagger)](https://drf-yasg.readthedocs.io/en/stable/)
Loading