Skip to content

Commit

Permalink
chore: monorepo setup (#20)
Browse files Browse the repository at this point in the history
Signed-off-by: Anurag Gupta <me@anuragxd.com>
Co-authored-by: Anurag Gupta <anurag@Anurags-MacBook-Pro.local>
  • Loading branch information
anuragxxd and Anurag Gupta authored May 15, 2023
1 parent bb43af6 commit 97b4f61
Show file tree
Hide file tree
Showing 49 changed files with 30,941 additions and 156 deletions.
10 changes: 10 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module.exports = {
root: true,
// This tells ESLint to load the config from the package `eslint-config-custom`
extends: [],
settings: {
next: {
rootDir: ["apps/*/"],
},
},
};
154 changes: 23 additions & 131 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,144 +1,36 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

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

# Runtime data
pids
*.pid
*.seed
*.pid.lock
# dependencies
node_modules
.pnp
.pnp.js

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

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

# nyc test coverage
.nyc_output

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

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

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

# Dependency directories
node_modules/
jspm_packages/
# misc
.DS_Store
*.pem

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

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

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity
# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# dotenv environment variable files
# local env files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
.env.local

# 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

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

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

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit
# turbo
.turbo

# End of https://www.toptal.com/developers/gitignore/api/node
# vercel
.vercel
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
auto-install-peers = true
12 changes: 12 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**/.git
**/.svn
**/.hg
**/node_modules

/.github/*
CONTRIBUTING.md
LICENSE
README.md
CONTRIBUTORS.md
CODE_OF_CONDUCT.md
```
12 changes: 6 additions & 6 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
> change. Please use bullet points for the description. For very trivial issues
> that are duly explained by the PR title, a description can be omitted.
-
-

Fixes #(issue)

Expand Down Expand Up @@ -46,7 +46,7 @@ Fixes #(issue)
- [ ] I have asked the [@all-contributors bot][all-contributors-bot] to
acknowledge my contributions by commenting on this PR with a request of
the form `@all-contributors please add @YOUR_GH_HANDLE for TYPE_1,
TYPE_2, ...`, where `TYPE_1` etc. refer to [contribution types supported
TYPE_2, ...`, where `TYPE_1` etc. refer to [contribution types supported
by the All Contributors Specification][all-contributors-types] OR I do
not want my contributions to be acknowledged

Expand All @@ -58,8 +58,8 @@ Fixes #(issue)
> _not_ be squased when merging, please explain why you think the PR warrants
> or requires multiple commits to be added to the history.
[all-contributors-bot]: <https://allcontributors.org/docs/en/bot/overview>
[all-contributors-types]: <https://allcontributors.org/docs/en/emoji-key>
[all-contributors-bot]: https://allcontributors.org/docs/en/bot/overview
[all-contributors-types]: https://allcontributors.org/docs/en/emoji-key
[contributing]: CONTRIBUTING.md
[conventional-commits]: <https://www.conventionalcommits.org/en/v1.0.0/>
[jsdoc]: <https://jsdoc.app/index.html>
[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/
[jsdoc]: https://jsdoc.app/index.html
75 changes: 56 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,56 @@
# ELIXIR Cloud Components

Elixir Cloud Components is lightweight, fast, and reusable web-components developed by Elixir Cloud and AAI Community for managing and accessing various services.

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[badge-all-contributors-image]: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square&color=%23F6DA80%20

<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![License][badge-license-image]][badge-license-url]
[![All Contributors][badge-all-contributors-image]][contributors]
[![Chat][badge-chat-image]][badge-chat-url]

## Synopsis
## Introduction

This repository follows the monorepo architecture (using [TurboRepo](https://turbo.build/repo)) that follows the common convention of having having top-level `apps/` and `packages/` directories.
The apps folder should contain workspaces for launchable apps, such as a [Next.js](https://nextjs.org/) or [Svelte](https://svelte.dev/) app.
The packages folder should contain workspaces for packages used by either an app or another package.

Workspaces are the building blocks of your monorepo. Each app and package you add to your monorepo will be inside its own workspace.

### Packages

| Name | Description | Version | Status |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ----------- |
| elixir-ui | This package serves as an abstraction layer for other packages, providing a streamlined approach for extracting common design token logic. | [0.0.1]() | In progress |

### Apps

| Name | Description | Deployment |
| ------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------- |
| example-usage | This application serves as a comprehensive guide for users on how to utilize the packages available in the sample app. | [NA]() |

## Getting Started

To get started with this project, follow these steps:

> Note: All of the following commands should be executed on all the packages & apps. In case you want to execute the script on any one particular app/package, you can define the [workspace tag](https://turbo.build/repo/docs/handbook/package-installation#addingremovingupgrading-packages) along with any of the below commands.
1. Install the dependencies involved by running the following command:

```
npm install
```

{{web-component.synopsis}}
2. Run the development server by running the following command:

## Usage
```
npm run dev
```

## Configuration
This will start the development server on your local machine and allow you to start working on the project.

## Contributing

Expand Down Expand Up @@ -67,34 +104,34 @@ the umbrella of the [ELIXIR][elixir] [Compute Platform][elixir-compute].

To get in touch with use, please use one of the following routes:

* For filing bug reports, feature requests or other code-related issues, please
- For filing bug reports, feature requests or other code-related issues, please
make use of the project's [issue tracker][issues].
* For more general discussions or questions on usage, please use the
- For more general discussions or questions on usage, please use the
organization's [discussion forum][forum]. If the issue is related to this
project, please indicate its name in your message body.
* For private/personal issues, more involved communication, or if you would
- For private/personal issues, more involved communication, or if you would
like to join our team as a regular contributor, you can either join our
[chat board][badge-chat-url] or send an [email][email] to the community
leaders.

[![logo-elixir][logo-elixir]][elixir]
[![logo-elixir-cloud-aai][logo-elixir-cloud-aai]][elixir-cloud-aai]

[all-contributors]: <https://allcontributors.org/docs/en/specification>
[all-contributors-bot]: <https://allcontributors.org/docs/en/bot/overview>
[all-contributors-types]: <https://allcontributors.org/docs/en/emoji-key>
[badge-license-image]:<https://img.shields.io/badge/license-Apache%202.0-blue.svg>
[badge-license-url]:<http://www.apache.org/licenses/LICENSE-2.0>
[badge-chat-image]: <https://img.shields.io/static/v1?label=chat&message=Slack&color=ff6994>
[badge-chat-url]: <https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM>
[email]: <alexander.kanitz@alumni.ethz.ch>
[all-contributors]: https://allcontributors.org/docs/en/specification
[all-contributors-bot]: https://allcontributors.org/docs/en/bot/overview
[all-contributors-types]: https://allcontributors.org/docs/en/emoji-key
[badge-license-image]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
[badge-license-url]: http://www.apache.org/licenses/LICENSE-2.0
[badge-chat-image]: https://img.shields.io/static/v1?label=chat&message=Slack&color=ff6994
[badge-chat-url]: https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM
[email]: alexander.kanitz@alumni.ethz.ch
[code-of-conduct]: CODE_OF_CONDUCT.md
[contributing]: CONTRIBUTING.md
[contributors]: CONTRIBUTORS.md
[elixir]: <https://elixir-europe.org/>
[elixir-cloud-aai]: <https://elixir-cloud.dcc.sib.swiss/>
[elixir-compute]: <https://elixir-europe.org/platforms/compute>
[ga4gh]: <https://ga4gh.org/>
[elixir]: https://elixir-europe.org/
[elixir-cloud-aai]: https://elixir-cloud.dcc.sib.swiss/
[elixir-compute]: https://elixir-europe.org/platforms/compute
[ga4gh]: https://ga4gh.org/
[license]: LICENSE
[logo-elixir]: images/logo-elixir.svg
[logo-elixir-cloud-aai]: images/logo-elixir-cloud-aai.svg
35 changes: 35 additions & 0 deletions apps/example-usage/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
Loading

0 comments on commit 97b4f61

Please sign in to comment.