Skip to content

Commit 4d69932

Browse files
committed
changed README github links to mongodb-labs
1 parent 6c04fe2 commit 4d69932

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Here are some short guidelines to guide you if you want to contribute to the development of the Full Stack FastAPI PostgreSQL project generator itself.
3+
Here are some short guidelines to guide you if you want to contribute to the development of the Full Stack FastAPI MongoDB project generator itself.
44

55
After you clone the project, there are several scripts that can help during development.
66

{{cookiecutter.project_slug}}/README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,24 @@ If your Docker is not running in `localhost` (the URLs above wouldn't work) chec
3939

4040
## Backend local development, additional details
4141

42+
### Setting Up MongoDB
43+
44+
**The backend and celery containers will fail to load if a proper Mongo URI is not configured**.
45+
46+
Please ensure that either
47+
- `MONGO_(HOST|USER|PASSWORD|DATABASE)` were properly set in the initial MongoDB setup phase
48+
- `MONGO_DATABASE_URI` has been set in `{{ cookiebutter.project_slug }}/.env`
49+
50+
To learn more about how to generate a MongoDB URI please look at the docs on [Connecting to your MongoDB Atlas Clutser](https://www.mongodb.com/docs/atlas/tutorial/connect-to-your-cluster/)
51+
52+
### Setting Up MongoDB Locally
53+
54+
**Currently, the FARM-stack generator does not provide a running `mongod` within the docker container**
55+
56+
If running a local instance of MongoDB outside of a docker container that you want your backend to communicate with, you will need to set up [port forwarding in your docker config](https://docs.docker.com/desktop/networking/#use-cases-and-workarounds). Since the intention of this generator is to work with scalable production environments very quickly, providing a local container of MongoDB was not part of the initial charter in its creation. **We do strongly advise you connect to an Atlas cluster**
57+
58+
To see how to use MongoDB with Docker, read through this article on [set-up steps](https://www.mongodb.com/compatibility/docker)
59+
4260
### General workflow
4361

4462
By default, the dependencies are managed with [Hatch](https://hatch.pypa.io/latest/), go there and install it.
@@ -62,7 +80,7 @@ Next, open your editor at `./backend/app/` (instead of the project root: `./`),
6280
$ code .
6381
```
6482

65-
Modify or add SQLAlchemy models in `./backend/app/app/models/`, Pydantic schemas in `./backend/app/app/schemas/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.
83+
Modify or add beanie models in `./backend/app/app/models/` (make sure to include them in `MODELS` within `.backend/app/app/models/__init__.py`), Pydantic schemas in `./backend/app/app/schemas/`, API endpoints in `./backend/app/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/app/crud/`. The easiest might be to copy the ones for Items (models, endpoints, and CRUD utils) and update them to your needs.
6684

6785
Add and modify tasks to the Celery worker in `./backend/app/app/worker.py`.
6886

@@ -749,11 +767,11 @@ Traefik UI: http://localhost.tiangolo.com:8090
749767

750768
## Project generation and updating, or re-generating
751769

752-
This project was generated using https://github.com/whythawk/full-stack-fastapi-postgresql with:
770+
This project was generated using https://github.com/mongodb-labs/full-stack-fastapi-mongodb with:
753771

754772
```bash
755773
pip install cookiecutter
756-
cookiecutter https://github.com/whythawk/full-stack-fastapi-postgresql
774+
cookiecutter https://github.com/whythawk/full-stack-fastapi-mongodb
757775
```
758776

759777
You can check the variables used during generation in the file `cookiecutter-config-file.yml`.
@@ -771,7 +789,7 @@ You can use that file while generating a new project to reuse all those variable
771789
For example, run:
772790

773791
```console
774-
$ cookiecutter --config-file ./cookiecutter-config-file.yml --output-dir ../project-copy https://github.com/whythawk/full-stack-fastapi-postgresql
792+
$ cookiecutter --config-file ./cookiecutter-config-file.yml --output-dir ../project-copy https://github.com/mongodb-labs/full-stack-fastapi-mongodb
775793
```
776794

777795
That will use the file `cookiecutter-config-file.yml` in the current directory (in this project) to generate a new project inside a sibling directory `project-copy`.

{{cookiecutter.project_slug}}/frontend/app/components/Footer.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const footerNavigation = {
4848
{
4949
name: "GitHub",
5050
// TODO: Switch to mongo-labs
51-
href: "https://github.com/whythawk/full-stack-fastapi-postgresql",
51+
href: "https://github.com/mongodb-labs/full-stack-fastapi-mongodb",
5252
icon: githubIcon,
5353
},
5454
{

{{cookiecutter.project_slug}}/frontend/app/content/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Go to the directory where you want to create your project and run:
5252

5353
```bash
5454
pip install cookiecutter
55-
cookiecutter https://github.com/whythawk/full-stack-fastapi-postgresql
55+
cookiecutter https://github.com/mongodb-labs/full-stack-fastapi-mongodb
5656
```
5757

5858
### Generate passwords

0 commit comments

Comments
 (0)