NekoCap Server

The server used by NekoCap for caption submission and retrieval.
Get the extension: Chrome / Edge | Firefox
Website: NekoCap.com

Join the Discord here:

Server

The server runs on Parse. The NekoCap extension and website calls cloud functions implemented here.

This project shares Typescript types with the extension project so ensure that this project folder sits beside that or modify the path in tsconfig.json:

"paths": {
    ...
    "@/*": ["../nekocap/src/*"] // <-- Change to your nekocap project's path
    ...
}

Setup for local development

1. Run npm install
2. Install mongodb and create a new database.
3. Copy the contents of .env.sample to .env and fill in the details.
   • DATABASE_URI should be the mongodb URI for your database
   • FIREBASE_SERVICE_ACCOUNT is used for Firebase authentication, grab it from your Firebase project
4. Import database/nekocap-schema.json into a collection called _SCHEMA in your MongoDB database
5. Run npm run watch to start the server

If you want to build the NekoCap server Docker image

1. Copy the contents of Dockerfile.sample to Dockerfile, replace the placeholder strings
2. Change the path to the NekoCap extension project so that type definitions can be copied for the build.
3. Run npm run docker:build or build the docker image from a parent directory of this project as the Dockerfile references directories outside of this project.

   cd ..
   docker build --file="./nekocap-server/Dockerfile" --tag="nekocap-server" .

Environment variables

Variable	Type	Description	Example
DATABASE_URI	string	URI to the mongodb database.	mongodb://username:password@localhost/databaseName
APP_ID	string	App ID of your Parse Application. You are free to set any name you want for your own instance.
MASTER_KEY	string	Master key for the Parse server. Don't lose this and do NOT commit to the repository
SERVER_URL	string	The URL that Parse Cloud Code will use to connect to this Parse server. In development, if INTERNAL_PORT is part of this URL, it will be replaced by PORT. (Using the examples in this table, SERVER_URL will become http://localhost:4041/parse in development. This should also be the PARSE_INTERNAL_SERVER_URL environment variable in the frontend)	http://localhost:4042/parse
PUBLIC_SERVER_URL	string	Publically accessible server URL. This should correspond to NEXT_PUBLIC_PARSE_SERVER_URL on the frontend in production.	https://api.mynekocapinstance.com/parse
PORT	number	The port that the Parse server will listen to. In development, this is the port that the HTTP (not HTTPS) server will listen on. In production (when the PROD environment variable is defined), this is the port that the HTTPS server will listen on.	4041
INTERNAL_PORT	number	The port that the HTTP server will listen on. In development, PORT overrides this and this has no effect.	4042
FIREBASE_SERVICE_ACCOUNT	string	The path to the json file containing your firebase service account details	"firebase-service-account-key.json"
CLOUD_CODE_MAIN	string	Path to the main cloud code JS file	dist/cloud.js
SSL_CERT_PATH	string	Path to your SSL cert. Only needed in production.	/path/to/your/cert/cert.pem
SSL_KEY_PATH	string	Path to your private key. Only needed in production.	/path/to/your/cert/key.pem
PROD	any	Define this to denote that the server should be running in production mode
SENTRY_DSN	string	URL to send your Sentry events