Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 #928

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

V2 #928

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"presets": ["@babel/preset-react"],
"env": {
"development": {
"plugins": ["react-refresh/babel"]
}
}
}
1 change: 0 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: https://github.com/btzr-io/Villain/blob/master/SUPPORT.md#donations # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
71 changes: 61 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Test archives
playground/public/example_3.cbz

# Runtime data
pids
Expand All @@ -16,11 +23,12 @@ lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
Expand All @@ -29,22 +37,31 @@ bower_components
# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
typings/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

Expand All @@ -56,13 +73,47 @@ typings/

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# Test files
build/test_files
# DynamoDB Local files
.dynamodb/

# IDE files
.idea/
# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# Deploy for github pages
.deploy/
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
5 changes: 5 additions & 0 deletions .nolluprc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
contentBase: "./playground/public",
port: 8080,
hot: true,
};
4 changes: 0 additions & 4 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
{
"files": [".prettierrc", ".babelrc"],
"options": { "parser": "json" }
},
{
"files": "**/*.css.module",
"options": { "parser": "css" }
}
]
}
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,28 +68,15 @@ Supported archives formats by [`libarchive.js`](https://github.com/nika-begiashv
- `RAR v5`
- `TAR`

## Development

This repository is now a `mono-repo` and is maintained with [lerna](https://github.com/lerna/lerna)

### Setup
## Development:

Before you jump in the code please follow the initial setup guide for development:

1. Clone or fork this repository.
2. Run `yarn` command to install the project dependencies.
3. Run `yarn bootstrap` to install all dependencies from internal packages and link any cross-dependencies.

Thats it! Now you are ready to start fixing bugs and implementing new features. :tada:

### Packages

Available packages living inside this repository:
That's it! Now you are ready to start fixing bugs and implementing new features. :tada:

| Name | version | Description |
| -------------------------------------------------------------------------------------- | ------------ | ------------------- |
| [villain-web](https://github.com/btzr-io/Villain/tree/master/packages/villain-web) | 0.0.1 (beta) | web app + embed api |
| [villain-react](https://github.com/btzr-io/Villain/tree/master/packages/villain-react) | 1.0.7 | react component |

### Commands

Expand All @@ -98,13 +85,6 @@ Available package scripts for development:
| Name | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| deploy | Deploy [villain-web](https://github.com/btzr-io/Villain/tree/master/packages/villain-web) to github pages |
| bootstrap | Bootstrap the packages in the current mono repo |
| start:web | Start development webpack-dev-server (includes hot-reloading) of [villain-web](https://github.com/btzr-io/Villain/tree/master/packages/villain-web) |
| build:web | Build production version of [villain-web](https://github.com/btzr-io/Villain/tree/master/packages/villain-web) |
| start:react | Start development webpack-dev-server (includes hot-reloading) of [villain-react](https://github.com/btzr-io/Villain/tree/master/packages/villain-react) |
| build:react | Build production version of [villain-react](https://github.com/btzr-io/Villain/tree/master/packages/villain-react) |
| docs:copy | Prepare documents for docsify-cli |
| docsify:serve | Serve docsify generated document on localhost:3000 |

```sh
yarn command-name
Expand Down
26 changes: 0 additions & 26 deletions SUPPORT.md

This file was deleted.

19 changes: 0 additions & 19 deletions artworks/ARTWORKS_LICENSE.md

This file was deleted.

Binary file removed artworks/Screenshot_2019-11-27 Villain Demo(1).png
Binary file not shown.
Binary file removed artworks/Screenshot_2019-11-27 Villain Demo.png
Binary file not shown.
Binary file removed artworks/logo-small.png
Binary file not shown.
Binary file removed artworks/logo.png
Binary file not shown.
1 change: 0 additions & 1 deletion artworks/logo.svg

This file was deleted.

12 changes: 0 additions & 12 deletions deploy.sh

This file was deleted.

Empty file removed docs/.nojekyll
Empty file.
3 changes: 0 additions & 3 deletions docs/_404.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_coverpage.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/_sidebar.md

This file was deleted.

Loading