Git Product home page Git Product logo

flat-server's Introduction

flat-server

This project is the backend server for flat-desktop.

Features

  • Register and login with Wechat.

Development

Create these files with the format of config/.env.default:

  • config/.env.development.local
  • config/.env.production.local

See Building Guides for available variables.

Then at project root, run:

yarn install --frozen-lockfile
yarn run start

Building Guides

You should Fork this project then add the environment variables at https://github.com/[user-name]/flat-server/settings/secrets/actions.

Available environment variables:

Name Description
DOCKERHUB_USERNAME Your hub.docker.com user name
DOCKERHUB_TOKEN The generated token at hub.docker settings
SERVER_PORT The exposed public port of deployed service
WECHAT_APP_ID AppID of Website Apps on Wechat Open Platform
WECHAT_APP_SECRET AppSecret of Website Apps on Wechat Open Platform
REDIS_HOST redis host
REDIS_PORT redis port
REDIS_PASSWORD redis password
REDIS_DB redis db name
MYSQL_HOST MySQL host
MYSQL_PORT MySQL port
MYSQL_USER MySQL user name
MYSQL_PASSWORD MySQL password
MYSQL_DB MySQL database name
SSH_HOST Deployed SSH address
SSH_USERNAME SSH user name
SSH_KEY SSH key
SSH_PORT SSH port

Note that SSH_KEY is the secret key that is generated by ssh-keygen -t rsa -b 4096（starting with -----BEGIN OPENSSH PRIVATE KEY-----).

Then at the remote server, add the ssh public key to ~/.ssh/authorized_keys.

Tech Stack

flat-server's People

Contributors

blackhole1 avatar crimx avatar hyrious avatar dependabot[bot] avatar leavesster avatar alwaysmavs avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.