partisan-io

command module
v0.0.0-...-6dfde0d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2017 License: GPL-3.0 Imports: 25 Imported by: 0

README

Partisan.IO

Social networking app for discussion (arguing) regarding politics.

Prerequisites

Golang

Installation instructions: https://golang.org/doc/install

Homebrew

Run the following in your Terminal:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
NodeJS

Run the following in your Terminal:

brew install node

Running your project

The project has two components, the Go backend and the JS front end. The repo should have a build of the backend as an executable, so to start it, run the following in your Terminal:

./partisan

If you would like to build the backend from source, you'll first need the Golang environment installed. You'll also need to run go get to get all the dependencies. After you've done that, run the following in your Terminal:

go build

And then run the executable as in the previous command. The server will run at http://localhost:4000.

To build the front end, simply run the following.

npm start

This will watch the /src directory for any changes and automatically compile them into the /dist directory, provided there are no errors. Live reloading currently does not work as it conflicts with the backend, but we may fix that issue shortly.

Generating Additional Code

You can add additional functionality to your application by invoking the subgenerators included in the Flux Generator. You can add components using the following commands:

Components
$ yo flux:component ComponentName
Actions
$ yo flux:action ActionCreatorName
Stores
$ yo flux:store StoreName

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
v2
posts
Package posts contains functionality to create, find, and update posts, comments and likes.
Package posts contains functionality to create, find, and update posts, comments and likes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL