Skip to content

srfoster/nexus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nexus

The Nexus of the CodeSpells community. Deployed at nexus.codespells.org.

Interested in contributing to this open source project? The first step is to install Docker on your machine. You can find a download for Docker here. Then, follow these instructions:

Installation:

Pre-Installation: (Windows users only)

git config --global core.autocrlf false

Main Installation:

git clone [email protected]:srfoster/nexus.git
cd nexus
docker-compose -f stack.yml build

Development:

docker-compose -f stack.yml up

The database should get created and seeded the first time you do this.

Now you should be able to edit files in frontend/ or backend/. Reloading should be automatic.

Running tests:

docker exec -it backend npm run test
docker exec -it frontend npm run test

Or you can run a specific test with this command:

docker exec -it frontend npm test -- FileTo.test.js
docker exec -it backend npm test -- FileTo.test.js

Video Content Guidelines

Videos in the nexus need to render inside of Unreal. Currently, the only known format that renders correctly is OGV, so convert videos from mp4 to ogv with:

ffmpeg -i INPUT.mp4 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 OUTPUT.ogv

Also, for efficient loading 640x480 is a good resolution, so use:

ffmpeg -i INPUT.ogv -vf scale=640:480 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 OUTPUT.ogv