Ind.ie is now Small Technology Foundation.
README.md 1.71 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1
# Indie Site
Aral Balkan's avatar
Aral Balkan committed
2

Aral Balkan's avatar
Aral Balkan committed
3
> Federated Personal Web Site
Aral Balkan's avatar
Aral Balkan committed
4 5 6

## About

Aral Balkan's avatar
Aral Balkan committed
7
This is a very early exploration of a federated personal web site.
Aral Balkan's avatar
Aral Balkan committed
8

Aral Balkan's avatar
Aral Balkan committed
9 10 11
For more information, please see the [Indienet project planning documentation at indienet.info](https://indienet.info).

## Development
Aral Balkan's avatar
Aral Balkan committed
12

Aral Balkan's avatar
Aral Balkan committed
13 14
1. `npm install`
2. `npm run dev`
Aral Balkan's avatar
Aral Balkan committed
15

16 17 18 19 20 21 22 23 24 25
To specify a port (e.g., two run two separate instances when testing federation), use:

`npm run dev -- --port 7999`

## Production

Not ready for production use.

(In production, the port is set either via the PORT environment variable or will fall back to the value in the _config/production.json_ from the Feathers configuration.)

Aral Balkan's avatar
Aral Balkan committed
26
## Configuration
Aral Balkan's avatar
Aral Balkan committed
27

Aral Balkan's avatar
Aral Balkan committed
28
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.
Aral Balkan's avatar
Aral Balkan committed
29

Aral Balkan's avatar
Aral Balkan committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
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.
Aral Balkan's avatar
Aral Balkan committed
45 46 47

## Testing

Aral Balkan's avatar
Aral Balkan committed
48 49 50
Run `npm run test` and all tests in the `test/` directory will be run.

## Dependencies
Aral Balkan's avatar
Aral Balkan committed
51

Aral Balkan's avatar
Aral Balkan committed
52
The only dependency is Node.js and node packages. Everything runs as a single process, including the database.
Aral Balkan's avatar
Aral Balkan committed
53 54 55

## Changelog

Aral Balkan's avatar
Aral Balkan committed
56
__1.0.0__
Aral Balkan's avatar
Aral Balkan committed
57

Aral Balkan's avatar
Aral Balkan committed
58
- In development.
Aral Balkan's avatar
Aral Balkan committed
59 60 61

## License

Aral Balkan's avatar
Aral Balkan committed
62
Copyright (c) 2018 Ind.ie.
Aral Balkan's avatar
Aral Balkan committed
63

Aral Balkan's avatar
Aral Balkan committed
64
Licensed under the [AGPL](LICENSE).