forked from FoundKeyGang/FoundKey
my fork with stuff that you would find on my instance
.ci-files | ||
.github | ||
docker | ||
elasticsearch | ||
resources | ||
src | ||
test | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
appveyor.yml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
gulpfile.js | ||
gulpfile.ts | ||
init.js | ||
jsconfig.json | ||
LICENSE | ||
package.json | ||
README.md | ||
tsconfig.json | ||
tslint.json | ||
update.sh |
Misskey
A miniblog-based SNS.
Build
- Install git, Node.js and npm
git clone git://github.com/syuilo/misskey.git
cd misskey
npm install
npm run config
npm run build
Test
npm test
Setup
Dependencies
Please install these softwares.
- MongoDB
- Redis
- GraphicsMagick
- Elasticsearch (optional)
Domains
Misskey requires two domains called the primary domain and the secondary domain.
- The primary domain is used to provide main service of Misskey.
- The secondary domain is used to avoid vulnerabilities such as XSS.
Ensure that the secondary domain is not a subdomain of the primary domain.
reCAPTCHA
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
Launch
sudo npm start
Contribute
Do you have feature request or problem with Misskey? Please create issue to report it.
Currently Misskey is missing documents so writing documents would be appreciated. Pull requests are always welcome.
We love contributions from anybody.