Ind.ie is now Small Technology Foundation.
Commit 80174aff authored by Aral Balkan's avatar Aral Balkan

Update readme files

parent c4c78185
......@@ -10,23 +10,36 @@ For more information, please see the [Indienet project planning documentation at
## Development
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
1. `npm install`
2. `npm run dev`
```
cd path/to/site; npm install
```
## Configuration
3. Start your app
The site configuration is currently in the _assets/_ directory. This will change shortly to a location that can be easily included during deployment and one that isn’t checked into source control.
```
npm run dev
```
The _data.json_ file in _assets/data.json_ currently contains data
pertaining to the owner of the site:
* Domain
* Name
* Bio
* Encrypted private key
* Public key
In the _assets/_ folder, there are also two image files:
* Profile image (profile-image.png)
* Background image (background-image.jpg)
These are currently treated as well-known locations, but they will later be served from the /profile-image and /background-image routes that abstract away the image types, etc., and can truly function as well-known locations and part of the site’s API.
## Testing
Simply run `./test` and all tests in the `test/` directory will be run.
Run `npm run test` and all tests in the `test/` directory will be run.
## Dependencies
The only dependency is Node.js and node packages. Everything runs as a single process, including the database.
## Changelog
......
......@@ -9,10 +9,11 @@ such as messages received and sent, etc., may be found in the LevelDB database.
Data housed here includes the following details about the site’s owner:
* Profile image
* Background image
* Domain
* Name
* Bio
* Profile image
* Background image
* Encrypted private key
* Public key
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment