Skip to content

Update development instructions #225

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
merged 5 commits into from
May 29, 2021
Merged

Update development instructions #225

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
24c451b
Update development instructions
thomashoneyman May 28, 2021
248c926
Fix header numbers
thomashoneyman May 28, 2021
0691abf
Add cd client
thomashoneyman May 28, 2021
7046f27
prod -> production
thomashoneyman May 28, 2021
2bbd08a
Update README.md
thomashoneyman May 28, 2021
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
61 changes: 41 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,44 +74,65 @@ Before deploying an updated package set, someone (your reviewer) should check th

## Development

### 1. Client setup
### 1. Shared setup

These steps should be performed whether you are working on the server, the client, or both.

```sh
# Clone into the repository
git clone [email protected]:purescript/trypurescript.git
cd trypurescript/client
cd trypurescript

npm install
npm run build

cd public
httpserver 8080 #eg with: alias httpserver='python -m SimpleHTTPServer'
open http://localhost:8080
```

### 2. Local compile server setup

```sh
git clone [email protected]:purescript/trypurescript.git
cd trypurescript
This step sets up a local server for Try PureScript. You can skip this step if you just want to use the client with the production server.

```sh
# Build the trypurescript executable
stack build

# Install PureScript dependencies
# Set up the PureScript environment for the server
cd staging
spago install
spago build

# Below, we disable glob expansion via `set -o noglob`
# to prevent 'ModuleNotFound' errors. `purs` will handle
# glob expansion correctly for us. See #220 for more contxt.
# Ensure the compiled JavaScript is available to the client
ln -s output ../client/public/js/output

# Then, start the server.
#
# Below, we disable glob expansion via `set -o noglob` to ensure that globs are
# passed to `purs` unchanged.
#
# We run this in a subshell so the change doesn't persist after
# running the below command
# We run this in a subshell so that setting noglob only lasts for the duration
# of the command and no longer.
(set -o noglob && stack exec trypurescript 8081 $(spago sources))
# should output that is is compiling the sources (first time)
# then: Setting phasers to stun... (port 8081) (ctrl-c to quit)

# Should output that it is compiling the sources (first time)
# Then: Setting phasers to stun... (port 8081) (ctrl-c to quit)
```

### 3. Client setup

```sh
# Install development dependencies
cd client
npm install

# Use `build:dev` if you are using a local Try PureScript server, e.g. you
# followed the instructions in step 1.
#
# Use `build:production` if you would like to test the client against the production
# Try PureScript server.
npm run build:(dev|production)

cd public
npx http-server # Try PureScript is now available on localhost:8080
```

### 3. Choosing a Tag
### 4. Choosing a Tag

The built-in examples for Try PureScript are loaded from this GitHub repository. To change the tag that the examples are loaded from, you'll need to touch three files:

Expand Down