Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 415c7d6

Browse files
build: npm v7 and workspaces (#1322)
* build: npm v7 and workspaces * build: components and templates * chore: prettier defined at root * build: common components tsconfig * build: cli workspace * chore: prettier format width and no trailing comma * fix: ignore prettier format * chore: prettier defined in root * build: utils workspace * build: tsconfig parent * build: npm v7 * build: npm v7 * build: docs workspace * chore: prettier format * build: workspace remote * chore: prettier format * chore: prettier ignore long line * build: workspace site * chore: prettier format * build: npm v7 * build: fix estree * build: style path * build: studio workspace * chore: prettier format * build: remove cli from workspaces * build: rever, remove apps form workspaces I want to used pinned published versions to build apps and not those build locally * build: remove cli from workspaces * docs: general installation and development how-to
1 parent c9a22b3 commit 415c7d6

File tree

579 files changed

+99184
-99461
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

579 files changed

+99184
-99461
lines changed

.prettierignore

+18
Original file line numberDiff line numberDiff line change
@@ -1 +1,19 @@
11
**/src/components.d.ts
2+
dist
3+
www
4+
loader
5+
.stencil
6+
7+
webcomponents/*/src/**/readme.md
8+
templates/*/src/**/readme.md
9+
10+
lib
11+
12+
docs/storybook-static/**/*
13+
14+
.firebase
15+
16+
.cache
17+
public
18+
19+
.dfx
File renamed without changes.

DEV.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Development
2+
3+
Beside the [infra](https://github.com/deckgo/deckdeckgo/tree/main/infra) and code related to the [Internet Computer](https://dfinity.org/), this mono-repo is a collection a JavaScript, more precisely TypeScript project. To run or develop locally part it proceed as following:
4+
5+
### Getting Started
6+
7+
We are using `npm` **>= v7**.
8+
9+
### Web Components, Templates, Utils and Docs
10+
11+
The [webcomponents](https://github.com/deckgo/deckdeckgo/tree/main/webcomponents), [templates](https://github.com/deckgo/deckdeckgo/tree/main/templates), [utils](https://github.com/deckgo/deckdeckgo/tree/main/templates) and [docs](https://github.com/deckgo/deckdeckgo/tree/main/templates) are npm [workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces/).
12+
13+
To get the repo and install the dependencies run:
14+
15+
```
16+
git clone https://github.com/deckgo/deckdeckgo
17+
cd deckdeckgo
18+
npm ci
19+
```
20+
21+
To run one of these particular projects, from root, run:
22+
23+
```
24+
npm run start --workspace=webcomponents/core
25+
npm run start --workspace=templates/slide-title
26+
npm run start --workspace=docs
27+
npm run build --workspace=utils/kit
28+
```
29+
30+
### Apps, Backend and other projects
31+
32+
The other projects are not part of the workspaces. Reason behind is that for production we want to rely on pined and published dependencies and not those build locally as npm v7 create simlinks.
33+
34+
To get the repo, install the dependencies and run an apps, proceed as following:
35+
36+
```
37+
git clone https://github.com/deckgo/deckdeckgo
38+
cd deckdeckgo/studio
39+
npm ci
40+
npm run start
41+
```

backend/README.md

-12
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ It also transmits the information for the live voting when you are interacting w
1414
- [Receiver](#receiver)
1515
- [Emitter](#emitter)
1616
- [Poll](#poll)
17-
- [Develop](#develop)
1817
- [License](#license)
1918

2019
## Remote control
@@ -47,17 +46,6 @@ The voting ("where your audience are recording their votes") is implemented in [
4746

4847
The question and the display of the live results is implemented with a template in your presentation.
4948

50-
## Develop
51-
52-
If you would like to install and run locally this backend, proceed as following:
53-
54-
```
55-
git clone https://github.com/deckgo/deckdeckgo
56-
cd backend
57-
npm install
58-
npm run start
59-
```
60-
6149
## License
6250

6351
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])

0 commit comments

Comments
 (0)