mirror of
https://github.com/teoxoy/factorio-blueprint-editor.git
synced 2024-11-24 08:22:16 +02:00
update contributing doc
remove old start script
This commit is contained in:
parent
05b99599ae
commit
52e87cace0
@ -18,6 +18,9 @@ You can file new issues by selecting from our [new issue templates](https://gith
|
||||
- [yarn](https://yarnpkg.com)
|
||||
- [node](https://nodejs.org/en/)
|
||||
- [vscode](https://code.visualstudio.com/)
|
||||
- [rust](https://rust-lang.org)
|
||||
- [systemfd](https://github.com/mitsuhiko/systemfd)
|
||||
- [cargo-watch](https://github.com/passcod/cargo-watch)
|
||||
|
||||
### Note
|
||||
|
||||
@ -28,9 +31,10 @@ This project uses `eslint` and `prettier` to lint and format code. I would recom
|
||||
1. Fork the repo
|
||||
1. Clone your fork
|
||||
1. Download the recommended workspace extensions in vscode
|
||||
1. Make your changes in a new git branch (`git checkout -b my-fix-branch master`)
|
||||
1. Create a new git branch (`git checkout -b my-fix-branch master`)
|
||||
1. Create a new file at the path `packages/exporter/.env` and add your `FACTORIO_USERNAME` and `FACTORIO_TOKEN` (you can get those [here](https://factorio.com/profile))
|
||||
1. Run `yarn`
|
||||
1. Run `yarn start`
|
||||
1. Run `yarn start:website` and `yarn start:exporter`
|
||||
1. Open the link in a browser or use the vscode debugger
|
||||
1. Make changes
|
||||
1. Commit your changes using a descriptive commit message
|
||||
|
@ -7,7 +7,6 @@
|
||||
"start:website": "yarn workspace @fbe/website run start",
|
||||
"start:exporter": "cd ./packages/exporter && systemfd --no-pid -s http::8888 -- cargo watch -w ./src -x \"run --features dev\"",
|
||||
"build:website": "yarn workspace @fbe/website run build",
|
||||
"start": "concurrently \"yarn:start:backend\" \"yarn:start:website\"",
|
||||
"lint": "eslint **/*.ts --config .eslintrc.yml --ignore-path .gitignore",
|
||||
"lint:fix": "eslint **/*.ts --fix --config .eslintrc.yml --ignore-path .gitignore",
|
||||
"format": "prettier **/*.{js,ts,html,json,yml,md} --check --config .prettierrc.yml --ignore-path .gitignore",
|
||||
|
Loading…
Reference in New Issue
Block a user