ashpr/biscuitjs repository overview

⁠BiscuitJS

BiscuitJS is a social networking platform aimed to be similar to the website Reddit. It is made in my spare time to sharpen my NodeJS skills. This is still in development!

⁠Demo

http://biscuitjs.ashprosser.com/⁠

⁠Installation

The fastest way to get BiscuitJS going would be to use Docker with the dev docker-compose file included. There's a vagrant file if you don't even want to install Docker!

docker-compose up -d

If you wish to use the application in a more traditional sense, you will need a Redis and MongoDB server instance. You then need to set up the environment variables below on the NodeJS instance.

⁠Usage

Most of the settings can be adjusted with environment variables as specified below:

⁠Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request!

⁠History

TODO: Write history

⁠Credits

Ash Prosser @AshPross

⁠License

See LICENSE.txt

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.