Skip to content

Maybulb/Raven

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Raven

Only this and nothing more.

About

Raven is a network to share poetry, and all the creative ideas that come with it. It includes social elements such as commenting and annotation, but is not intended to be a traditional social network– instead serving as a modern medium between poets and readers.

Development

You'll need to get an instance of Mongo running first.

git clone https://github.com/maybulb/raven

cd raven && npm run mongo

Keep this session open, and open a new one in the same directory.

npm run start

API Routes/Map

Current roadmap, and will be updated in the future to support a public API which can be used by users, and will likely be used with our iOS app.

/ GET

If the user is logged in, will bring them to the home page.

If the user is not logged in it will bring them to the main index with Raven's description, as well as login/register buttons.

GET /post

Returns the page to post a poem. Redirects to login if the user is not authenticated.

POST /post

Takes 2 parameters through body (title, body), and creates a Poem object with the following model.

{
	"title": String,
	"body": String,
	"author": ObjectID,
	"preview": String
}

GET /settings

Returns the settings page, which includes logout and deactivate buttons, as well as a small form to change your username. Date of account creation is also listed. If user is not authenticated, redirect to login.

POST /settings