Skip to content

Commit

Permalink
Refactor README (#166)
Browse files Browse the repository at this point in the history
* Add screenshot

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus

* Add menus
  • Loading branch information
sykp241095 committed Apr 24, 2022
1 parent 86ae884 commit c296420
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 26 deletions.
71 changes: 45 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,60 @@
# Website
<h1 align="center">Open Source Software Insight!</h1>

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
<a href="https://ossinsight.io">
<img src="/static/img/screenshots/home.png"
</a>

### Installation
<h3 align="center">
<b><a href="https://ossinsight.io/database/deep-insight-into-open-source-databases">Insights</a></b>
<a href="https://ossinsight.io/compare/">Compare Projects</a>
<a href="https://ossinsight.io/try-your-own-dataset">Try Your Own Dataset</a>
<a href="https://twitter.com/PingCAP">Twitter</a>
</h3>

```
$ npm i
```

### Local Development
<p align="center">
OSS Insight analyze billions of GitHub events and get insights from them, also provide a compare tool which can compare any two open source software hosted on GitHub deeply.
</p>

```
$ npm start
```
## Insights
* [Deep Insight Into Open Source Databases](https://ossinsight.io/database/deep-insight-into-open-source-databases)
* [JavaScript Framework Repos Landscape 2021](https://ossinsight.io/js-framework/deep-insight-into-js-framework-2021)
* [Web Framework Repos Landscape 2021](https://ossinsight.io/web-framework/deep-insight-about-web-framework-2021)
* [Programming Languages Repos Landscape 2021](https://ossinsight.io/language/deep-insight-into-programming-languages-2021)
* [Low-code Development Tool Repos Landscape 2021](https://ossinsight.io/low-code/deep-insight-into-lowcode-development-tools-2021)

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
If you want to analyze more, please [contact us](https://ossinsight.io/about/#contact)

### Build
## Compare Projects

```
$ npm build
```
Examples:
* [Compare Vue and React](https://ossinsight.io/compare?repo1=vuejs%2Fvue&repo2=facebook%2Freact)
* [Compare Hugo and Docusaurus](https://ossinsight.io/compare?repo1=gohugoio%2Fhugo&repo2=facebook%2Fdocusaurus)
* [Compare CockroachDB and TiDB](https://ossinsight.io/compare?repo1=pingcap%2Ftidb&repo2=cockroachdb%2Fcockroach)
* [Compare PyTorch and TensorFlow](https://ossinsight.io/compare?repo1=pytorch%2Fpytorch&repo2=tensorflow%2Ftensorflow)
* [Compare Django and Flask](https://ossinsight.io/compare?repo1=django%2Fdjango&repo2=pallets%2Fflask)
* [Compare Visual Studio Code and Atom](https://ossinsight.io/compare?repo1=microsoft%2Fvscode&repo2=atom%2Fatom)
* [Compare Go and Rust](https://ossinsight.io/compare?repo1=golang%2Fgo&repo2=rust-lang%2Frust)

This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Development

### Deployment

Using SSH:

```
$ USE_SSH=true npm run deploy
clone the code by:
```bash
git clone https://github.com/pingcap/ossinsight.git
```

Not using SSH:

install npm packages
```bash
cd ossinsight/;
yarn;
```
$ GIT_USER=<Your GitHub username> npm run deploy

start the server:
```bash
yarn start;
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
then visit: http://localhost:3000
Binary file added static/img/screenshots/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c296420

Please sign in to comment.