Skip to content

Commit

Permalink
Add documentation for developing on syracuse tenants union website
Browse files Browse the repository at this point in the history
  • Loading branch information
1egoman committed Sep 1, 2019
1 parent 3fbe9dc commit 9a4dbd6
Show file tree
Hide file tree
Showing 4 changed files with 723 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
pass
*.sw*
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Syracuse Tenants Union

This is a squarespace theme for the syracuse tenants union.

## Getting started
_NOTE: You may need to be invited to the squarespace site for the below to work. If something below
doesn't work and you get an error related to not having permissions to access something, etc, that
might be the problem._

1. Make sure you are using node >= 10.7. Run `node -v` and check.
2. Run `npm install`.
3. Run `npm start`, wait for the server to start.
4. Visit `localhost:9000` in a web browser.

## Deployment
This project is set up with circleci so that when any commit is pushed to `master`, it is
auto-deployed to the production squarespace site. This should hopefully make it easier for multiple
people to work on this project at the same time.

The circleci job takes two environment variables, `$SQUARESPACE_EMAIL` and `$SQUARESPACE_PASSWORD`
which defines a set of login credentials that should be used when pushing the squarespace site.
These are configured within circleci as they are secrets.
Loading

0 comments on commit 9a4dbd6

Please sign in to comment.