Flipstarter

Flipstarter provides a way for any project to engage with potential funders in a way that encourages accountability for projects and fairness for funders.

The Flipstarter team has created these tools for anyone to use. Although we have worked hard to make Flipstarter easy to deploy and reliable to operate, the tools are offered as-is with no expectation of support. If you are not confident about your ability to deploy and manage a Flipstarter-based campaign, we recommend you work with a web developer who can manage everything for you.

Corentin Mercier offers a service here.

Development

Run the NodeJS development server

You need NodeJS installed on your machine, then run:

npm install
npm start

And open up localhost:3000 in your browser.

Run the Docker container

You need Docker installed on your machine, then run:

docker build -t flipstarter .
docker volume create flipstarter
docker run -v flipstarter:/app/db -p 3000:3000 flipstarter

And open up localhost:3000 in your browser.

Contribute

Submit pull requests at https://gitlab.com/flipstarter/backend

Edit front-end

HTML

HTML files are located in /views/.

CSS/images/fonts

These are located in /static/, in their respective folder.

JavaScript (front-end)

To edit the main application script, edit /source.js and run /webpack.sh to process it.

⚠️ Do NOT edit application.js directly ⚠️

Deploy to production

There are multiple ways to do this.

1. Use Digital Ocean Marketplace (coming soon)
2. Use a NodeJS image and serve server.js on port 80 or 443. You can also use a process manager like pm2
3. Deploy the docker container on port 80 or 443 using the following commands:

# download the latest version of flipstarter
docker pull flipstarter/flipstarter

# create a volume to store the database
docker volume create flipstarter

# run the container on ports 443 and 80
docker run -d --restart always --name flipstarter -v flipstarter:/app/db -p 443:3000 -p 80:3000 flipstarter/flipstarter

You can start and stop the container with docker [start/stop] flipstarter.

Built With

• css
• dockerfile
• html
• javascript
• shell