Giter VIP home page Giter VIP logo

sokudo's Introduction

๐Ÿ‘น Sokudo

Sokudo (speed from japanese) is an application that implements the principles of Agile software development, particularly project management, and is based on GitHub API using features offered by GitHub Apps.

Short demonstration:

Example #1 example_1
Example #2 example_2
Example #3 example_3

Built With

For more details check client/package.json and server/build.gradle.

Prerequisites

  • Java 16+
  • MongoDB instance (you can use docker container)
  • NodeJS 16.6+
  • NPM 7.20+

Installation

This section will show you how to install the frontend and backend parts to work together.

Backend:

  1. Go to the server folder.
  2. Run ./gradlew clean build to download all required dependencies.
  3. Open the properties file located at src/main/resources/application.properties.
  4. Define the following variables:
server.port=8900 # Default port.

spring.data.mongodb.host=host.docker.internal # Default host.
spring.data.mongodb.port=27017 # Default port.

git.provider.client.id=<github-apps-client-id> # Generated from GitHub Apps.
git.provider.client.secret=<github-apps-client-secret> # Generated from GitHub Apps.
git.provider.access.token.issuer.url=https://github.com/login/oauth/access_token # Default URL.

git.provider.base.url=https://api.github.com # Default URL.
  1. Run the application from your IDE or with the following command: ./gradlew bootRun.

Frontend:

  1. Go to the client folder.
  2. Run npm install.
  3. Create .env file.
  4. Open the created file with your favorite editor.
  5. Define the following variables:
VITE_GH_AUTHORIZE_URL=https://github.com/login/oauth/authorize
VITE_GH_CLIENT_ID=<github-apps-client-id> # Generated from GitHub Apps.
VITE_API_BASE_URL=http://<server-host>:<server-port>/api
VITE_OAUTH_PROXY_URL=http://<server-host>:<server-port>/proxy/oauth
  1. Save the file.
  2. Run application with npx vite --port=<port>.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

To Do ๐Ÿ› ๏ธ

  • Re-write backend in Kotlin (include securing end-points by repo/user names)
  • Add caching for external API calls.
  • Pre-authorize API methods using a list of current user repositories.
  • GH Token expired handler.
  • Add code docs for API.
  • Dark/white theme switch.
  • Add project and task filtering.

License

GPL3

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.