mirror of
https://codeberg.org/keyoxide/keyoxide-web.git
synced 2024-12-22 14:59:29 -07:00
Quickstart guidance updates
This commit is contained in:
parent
04180468ba
commit
5e0561df7e
2 changed files with 39 additions and 9 deletions
23
.vscode/launch.json
vendored
Normal file
23
.vscode/launch.json
vendored
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
{
|
||||||
|
// Use IntelliSense to learn about possible attributes.
|
||||||
|
// Hover to view descriptions of existing attributes.
|
||||||
|
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "Launch via yarn",
|
||||||
|
"runtimeVersion": "18",
|
||||||
|
"request": "launch",
|
||||||
|
"runtimeArgs": [
|
||||||
|
"dev"
|
||||||
|
],
|
||||||
|
"runtimeExecutable": "yarn",
|
||||||
|
"skipFiles": [
|
||||||
|
"<node_internals>/**"
|
||||||
|
],
|
||||||
|
"type": "node",
|
||||||
|
"env": { "DOMAIN": "localhost:3000"},
|
||||||
|
"outputCapture": "std"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
25
README.md
25
README.md
|
@ -41,14 +41,21 @@ Please note that this project has a [Code of Conduct](https://codeberg.org/keyox
|
||||||
|
|
||||||
To run Keyoxide locally on your machine for development:
|
To run Keyoxide locally on your machine for development:
|
||||||
|
|
||||||
- install either
|
1. Install Node using [nvm](https://github.com/nvm-sh/nvm): `nvm install --lts`
|
||||||
- NodeJS
|
2. Swap over to LTS: `nvm use --lts`
|
||||||
- directly from their [website](https://nodejs.org/en/), or
|
3. Ensure that yarn is installed: `npm install -g yarn`
|
||||||
- using [nvm](https://github.com/nvm-sh/nvm): `nvm install --lts; nvm use --lts`
|
4. Install node dependencies: `yarn`
|
||||||
- [yarn](https://yarnpkg.com/)
|
5. Run the server a la `DOMAIN='localhost:3000' yarn dev`
|
||||||
- [nix](https://nixos.org/guides/install-nix.html) with
|
|
||||||
[direnv](https://direnv.net/) will install yarn and other dependencies.
|
|
||||||
- install dependencies with `npm install` or `yarn`
|
|
||||||
- run the server with `npm dev` or `yarn dev`
|
|
||||||
|
|
||||||
Keyoxide will now be available at [https://localhost:3000](https://localhost:3000)
|
Keyoxide will now be available at [https://localhost:3000](https://localhost:3000)
|
||||||
|
|
||||||
|
For **vscode/vscodium** development, a `launcher.json` is provided. Ensure that
|
||||||
|
the first four steps have been performed at least once to ensure the proper
|
||||||
|
node and yarn binaries are available to vscode, then load the project. The
|
||||||
|
launcher provides a "Launch via yarn" debug option that will start the project
|
||||||
|
with the appropriate version and environment variables set. The project will
|
||||||
|
then be available in a browser.
|
||||||
|
|
||||||
|
There is also a `shell.nix` file to install Node and yarn (steps one through
|
||||||
|
three above).
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue