KickStart

KickStart - make your next project in weekends

Push keep it stupid simple to the maximum. Explore the true power of copy paste.

Who do you do this ? Just push KISS to it absolute limit

Design

Less color better. Black and white always in trend

Simple css setup

I prepare main.css with main color and few common styles like styles for text styles, border and grid

Components

You don't need any bootstrap or other ui libraries. One component for button and one for input it's all you need

Keep codebase as small as posible

One repository it's all you need. Use metaframework like Nuxt store all client and backend code into one repository

Make change quickly

Nuxt allow you to use hot-reload, which apply both change from client and backend immediately

One application for both

Nuxt allow you to ship your product with client and backend as single application

Implement own deployment it's not that hard

Modern industry try to convince you that deployment is hard, but it's actualy not

DockerFile

The project provide you with DockerFile, which fully prepared to run Nuxt application in production

docker-stack.yml

This file defines the services, networks, and volumes for deploying your application using Docker Stack. It ensures your app is configured correctly for production.

.github/workflow/publish.yml

This workflow file automates the deployment process using GitHub Actions. It builds your Docker image and pushes it to the container registry after deploy the application to any VPS by ssh whenever you push changes to the main branch.

KISS

You don't need any moderm deployment system like Vercel or AWS. You can use docker and deploy your app to any VPS. The docker itseft allow you to implemement blue-green deployment by docker stack and manage secrets by docker secrets

Features to copy paste

Social Auth (Google & GitHub)

Seamless authentication on multiple devices using OAuth2 with Google or GitHub no extra setup needed. You don't need any third party to implement social auth, all auth provider follow the save OAuth2 standard, it's just few http calls.

Admin Auth

You don't need to implement separate admin login flow, just login with your social account and add field isAdmin to your user record into database

Pre-built Landing Page

A clean and modern landing page structure is included by default, so you can quickly showcase your SaaS offering.

Get Started

Ready to dive in? Follow these steps from our README to set up KickStart for local development and beyond.

  1. Clone the Repository:

    git clone https://github.com/VovaStelmashchuk/kickstart

  2. Create a .secret.json file:

    Store your sensitive data (Mongo URL, OAuth keys, etc.) in this file. A sample:

  3. Install Dependencies:

    npm install

  4. Start the Development Server:

    npm run dev

    Your app will be running at http://localhost:3000.

Deploy to Any VPS

KickStart uses Docker Stack for seamless deployment to any virtual private server. For instance, we personally use Hetzner (hosting multiple projects on a single VPS at just 3.29 EUR per month).

Some Projects Hosted on the Same Server:

Frequently Asked Questions

Is KickStart free?

Yes, it's completely open-source. Feel free to use and modify!

Which technologies are included?

Nuxt 3 (Vue), Tailwind CSS, MongoDB integration, Docker, and GitHub Actions for CI/CD are all set up.

Can I contribute to the project?

Absolutely! Check out our GitHub repository to open issues or submit PRs.