app-stormkit-io - GitLite

KO | EN

gitlite — search

#python #react #go #android #linux #docker #nodejs #macos #windows #kubernetes #awesome-list #vue #ios #open-source

app-stormkit-io

(★ 95)

Stormkit is an all in one solution for Full Stack Javascript applications.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
  - project-setup-issue.md
- - codeql-analysis.yml
  - commitlint.yml
  - release.yml
- dependabot.yml
- file-mock.js
- - CenterLayout.tsx
- - mui-theme.tsx
  - Root.context.ts
  - Root.tsx
  - routes.tsx
- - favicon-299x299.png
  - favicon-69x69.png
  - favicon.png
  - manifest.json
- - helpers.tsx
  - setup.tsx
- - api_key.d.ts
  - app.d.ts
  - audit.d.ts
  - context.d.ts
  - data-store.d.ts
  - deployment.d.ts
  - environment.d.ts
  - feature-flags.d.ts
  - function-triggers.d.ts
  - functions.d.ts
  - index.d.ts
  - pagination.d.ts
  - provider.d.ts
  - teams.d.ts
  - theme.d.ts
  - user.d.ts
  - volume.d.ts
- index.css
- index.html
- index.tsx
.dockerignore
.env.example
.eslintrc
.gitignore
.prettierrc
CODE_OF_CONDUCT.md
commitlint.config.js
Dockerfile
LICENSE
package-lock.json
package.json
postcss.config.js
README.md
redirects.json
tailwind.config.js
tsconfig.json
vite.config.mts
vitest.config.ts

# Installation Guide

1. Get the code

git clone https://github.com/stormkit-io/app-stormkit-io

Downloads the entire project code from GitHub to your computer.

cd app-stormkit-io

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t app-stormkit-io .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 app-stormkit-io

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install

Downloads and installs the libraries listed in package.json.

$ npm run dev:live

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## This repository has been archived.

Visit [https://github.com/stormkit-io/stormkit-io](https://github.com/stormkit-io/stormkit-io) instead. It contains the backend and frontend logic together.

<hr />

<p align="center">
  <img src="./src/assets/logos/stormkit-logo-text-h-white.svg?raw=true" height="90"/>
</p>
<p align="center">
  <i>Stormkit is an infrastructure provider for jamstack applications. It perfectly integrates with popular Git solutions.<br/>Try out Stormkit using our hosted version at <a href="https://app.stormkit.io">app.stormkit.io</a>.</i>
  <br/>
  <br/>
  <img src="./src/assets/images/stormkit-tool.png" alt="Stormkit" width="800" />
</p>

This repository contains code related to the application frontend. You're more than welcome to contribute.

## What is Stormkit?

Stormkit helps developers build, deploy and manage their jamstack applications. It also supports serverless applications.

## Latest development

You can preview the latest development on [https://app.stormkit.io/](https://app.stormkit.io). This will reflect
changes from latest master branch.

## Contributing

If you'd like to contribute to this project, you can do so by

1. Fork this repo
2. Clone the fork to your local machine
3. Do the necessary changes (see [Development](#development) below)
4. Write a meaningful commit message and squash multiple commits
5. Submit your changes and open a new PR by choosing this repository as the upstream

## Development

After you have cloned this repository to your local machine execute the following commands:

```bash
# install dependencies
$ npm install

# serve with hot reload at localhost:3000 (pointing to live api)
$ npm run dev:live
```

Your project will be running at [https://localhost:3000](https://localhost:3000)

You'll need a backend to work with. Currently the backend is not open-source. To speed up the process however,
it's possible to create a proxy and point directly the live API which will allow local development. In order to do
that simply create an `.env` file and specify the following environment variables:

```
PORT=8080
API_DOMAIN=/api
API_PROXY_DOMAIN=http://localhost:8080/
STRIPE_API_KEY=pk_test_BeWmmZ8Sd6tdYHNOtmThjYXm00QZbiTJYt
```

## Open Source

You can check the [LICENSE](/LICENSE) for more information.