Giter Club home page Giter Club logo

cpany's Introduction

๐Ÿฅ– CPany

version Demo build-test

Competitive Programming Statistic Analysis Site Generator.

Screen shot

Getting Started

Use CPany template cpanyjs/template to create your own repository for data storage.

Update config file cpany.yml, and push the changes to Github.

Then, Github Actions will automatically fetch data and push to your repository!

Deploy

You can use Netlify, Vercel, Github Pages, etc. to deploy generated static site.

Netlify

The template repository has provided Netlify config file netlify.toml with the following content.

[build.environment]
  NODE_VERSION = "14"

[build]
  publish = "dist"
  command = "npm run build"

[[redirects]]
  from = "/*"
  to = "/index.html"
  status = 200

Then you can just create a new CPany site with your repository on Netlify.

Vercel

The template repository has provided Vercel config file Vercel.json with the following content.

{
  "rewrites": [
    { "source": "/(.*)", "destination": "/index.html" }
  ]
}

Then you can just create a new CPany site with your repository on Vercel.

Github Pages

The template repository has also provided a workflow gh-pages.yml, which will automatically push the generated static site to the branch gh-pages. You can just enable Github Pages in the Settings of your repository.

Run locally

Install Node.js >= 14.

Run one of the following commands to install @cpany/cli globally.

# npm
npm i -g @cpany/cli

# yarn
yarn global add @cpany/cli

Create an empty foler, and create cpany.yml in this new folder.

# prepare folder
mkdir cpany-data
cd cpany-data
echo "users:" > cpany.yml
echo "  tourist:" >> cpany.yml
echo "    handle/codeforces: tourist" >> cpany.yml

Fetch data, and start your static site.

# fetch data
cpany action

# Start dev server
cpany dev

# Build static site
cpany build

License

MIT License ยฉ 2021 XLor

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.