Skip to content
This repository has been archived by the owner on Feb 28, 2022. It is now read-only.

MxOliver/wikology

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wikology

A node based application for creating and sharing wikis.

Stack: Node.js, Express, Sequelize (Postgres)


Set Up

This app is available in production here but if you would like to run it in a development setting and need help on how to get it from this repository to your computer, check out this handy guide here

WIKOLOGY

Wikology is a node based application for creating and sharing wikis. As a user with a free account you can create as many wikis as you'd like, as well as edit other user's wikis. You can also upgrade to a premium account (using the Stripe API client) and create private wikis that are only visible by you and your chosen collaborators (who must also be premium users).

To start, click sign up to create an account and then you are ready to start making and collaborating on all the public wikis.

To try out the premium account feature, Stripe has a list of test payment credentials you can use such as 4242 4242 4242 4242 and any random 3 digit CVV code, use with a random fake email.

wiki goose meme

App Configuration

  1. CLICK clone or download and COPY the link

  2. OPEN terminal and run git clone <link> + (optional <custom-filename-of-your-choosing>)

  3. THEN cd into the folder containing the source code

Database Set Up

  1. run sequelize db:create + sequelize db:migrate (optional for testing environment: sequelize db:create --env test sequelize db:migrate --env test

API Keys

  1. In the root directory touch app.env to create a file to store your secret keys

  2. You will need a stripe API key and a sendgrid API key and a cookieSecret for the express session

cookieSecret='enter random string here';
export STRIPE_API_KEY='key here';
export SENDGRIND_API_KEY='key here';

  1. run source app.env in your terminal (there will be no response from this command)

  2. finally run npm start

you should see something like this in your terminal:

> bloccodechallenge@1.0.0 start <path/to/sourcecode>
> node src/server.js

server listening for requests on port 3000
  1. Once that third line appears (server is listening...) you can go ahead and open your favorite web browser and go to localhost:3000

About

A node based application for creating and sharing wikis.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published