puki

README

Puki - BUPT Lantu Developer Platform

An awesome Developer Platform to develop your projects!


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• React
• GORM

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• golang

Installation

1. Clone the repo

   git clone https://github.com/lantu-dev/puki.git
   

2. Download Go Mod

   go mod download
   

3. Install NPM packages

   cd app && yarn && cd ..
   cd site && yarn && cd ..
   

4. MakeDir For Build

   mkdir build
   

5. Build frontend

   cd app && ENABLE_GATEWAY=true yarn build && mv dist ../build/ && cd ..
   

6. Build docusaurus

   sed -i 's/CI_BUILED_BASEURL/\//' ./site/docusaurus.config.js && cd site && yarn build && mv build ../build/dist/site && cd ..
   

7. Build backend

   CC=aarch64-linux-gnu-gcc CXX=aarch64-linux-gnu-g++ CGO_ENABLED=1 GOOS=linux GOARCH=arm64 go build -o build/puki github.com/lantu-dev/puki/cmd/main
   

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MPL-2.0 License. See LICENSE for more information.

Contact

Project Link: https://github.com/lantu-dev/puki