factorio-sites/README.md

# FactorioSites

Mono-repo for [Factorio Blueprints](https://factorioblueprints.tech).

Factorio Blueprints delivers a platform to easily share blueprints and with minimal effort get the most value from them, with advanced search and real-time rendering of blueprints.

# Links

- [Issues & Suggestions](https://github.com/barthuijgen/factorio-sites/issues)
- [Roadmap](https://github.com/barthuijgen/factorio-sites/projects/1)

# Credits

Factorio Blueprints uses a part of the [Factorio blueprint editor](https://github.com/teoxoy/factorio-blueprint-editor) by [Teoxoy](https://github.com/Teoxoy). Lisenced MIT.

This amazing project allows us to render real time high quality images directly when opening any blueprint.

# Want to contribute?

## Prerequisites

- A postgres database (docker-compose.yml provided)
- A Google Cloud Platform project

## Setting up the project

- Add a `.env.local` file to apps/blueprints/ with the following values

```
POSTGRES_DB=factorio-blueprints
POSTGRES_USER=factorio-blueprints
#POSTGRES_HOST=127.0.0.1
#POSTGRES_PASSWORD=local
STEAM_WEB_API_KEY=(optional, for steam login)
GOOGLE_APPLICATION_CREDENTIALS="full/path/to/json-key-file.json"
GCP_BLUEPRINT_STRINGS_BUCKET=blueprint-strings
GCP_BLUEPRINT_IMAGES_BUCKET=blueprint-images
```

- Add a `.env` file to apps/blueprints/prisma with a database connection url like

```
DATABASE_URL="postgresql://factorio-blueprints:local@127.0.0.1:5432/factorio-blueprints"
```

- Run DB migration

```
cd apps/blueprints && npx prisma migrate deploy --preview-feature
```

- Run local app

```
nx serve
```
initial commit 2020-10-16 19:37:34 +02:00			`# FactorioSites`

Readme and github languages fix 2021-03-13 02:00:19 +02:00			`Mono-repo for [Factorio Blueprints](https://factorioblueprints.tech).`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`Factorio Blueprints delivers a platform to easily share blueprints and with minimal effort get the most value from them, with advanced search and real-time rendering of blueprints.`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`# Links`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`- [Issues & Suggestions](https://github.com/barthuijgen/factorio-sites/issues)`
			`- [Roadmap](https://github.com/barthuijgen/factorio-sites/projects/1)`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`# Credits`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`Factorio Blueprints uses a part of the [Factorio blueprint editor](https://github.com/teoxoy/factorio-blueprint-editor) by [Teoxoy](https://github.com/Teoxoy). Lisenced MIT.`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`This amazing project allows us to render real time high quality images directly when opening any blueprint.`
Added several ways of generating images, factorioprints scraper and a lot of updates to the main site 2020-10-22 15:53:06 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`# Want to contribute?`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`## Prerequisites`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`- A postgres database (docker-compose.yml provided)`
			`- A Google Cloud Platform project`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`## Setting up the project`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			- Add a `.env.local` file to apps/blueprints/ with the following values
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			```
			`POSTGRES_DB=factorio-blueprints`
			`POSTGRES_USER=factorio-blueprints`
			`#POSTGRES_HOST=127.0.0.1`
			`#POSTGRES_PASSWORD=local`
			`STEAM_WEB_API_KEY=(optional, for steam login)`
			`GOOGLE_APPLICATION_CREDENTIALS="full/path/to/json-key-file.json"`
			`GCP_BLUEPRINT_STRINGS_BUCKET=blueprint-strings`
			`GCP_BLUEPRINT_IMAGES_BUCKET=blueprint-images`
			```
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			- Add a `.env` file to apps/blueprints/prisma with a database connection url like
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			```
			`DATABASE_URL="postgresql://factorio-blueprints:local@127.0.0.1:5432/factorio-blueprints"`
			```
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			`- Run DB migration`
initial commit 2020-10-16 19:37:34 +02:00
Downgrade framed-motion to prevent depreceation warning, rewrote root readme 2021-03-11 23:59:31 +02:00			```
			`cd apps/blueprints && npx prisma migrate deploy --preview-feature`
			```

			`- Run local app`

			```
			`nx serve`
			```