Commit Graph

63 Commits

Author SHA1 Message Date
Chocobozzz
3a4992633e
Migrate server to ESM
Sorry for the very big commit that may lead to git log issues and merge
conflicts, but it's a major step forward:

 * Server can be faster at startup because imports() are async and we can
   easily lazy import big modules
 * Angular doesn't seem to support ES import (with .js extension), so we
   had to correctly organize peertube into a monorepo:
    * Use yarn workspace feature
    * Use typescript reference projects for dependencies
    * Shared projects have been moved into "packages", each one is now a
      node module (with a dedicated package.json/tsconfig.json)
    * server/tools have been moved into apps/ and is now a dedicated app
      bundled and published on NPM so users don't have to build peertube
      cli tools manually
    * server/tests have been moved into packages/ so we don't compile
      them every time we want to run the server
 * Use isolatedModule option:
   * Had to move from const enum to const
     (https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums)
   * Had to explictely specify "type" imports when used in decorators
 * Prefer tsx (that uses esbuild under the hood) instead of ts-node to
   load typescript files (tests with mocha or scripts):
     * To reduce test complexity as esbuild doesn't support decorator
       metadata, we only test server files that do not import server
       models
     * We still build tests files into js files for a faster CI
 * Remove unmaintained peertube CLI import script
 * Removed some barrels to speed up execution (less imports)
2023-08-11 15:02:33 +02:00
Chocobozzz
18c53ef949 Fix activitypub doc URL 2023-05-09 08:57:34 +02:00
Mats Blomdahl
907bcfa02c
Misc wording fixes, while learning how to test/contribute (#5727)
* Misc wording fixes, while learning how to test/contribute

- Remove duplicate discrimination topic in Code of Conduct
- Correct capitalization of some brands (PeerTube, GitHub)
- Replace `npm` with `yarn`, for additional consistency

* Revert `yarn` to `npm run` per PR #5727 comment

* Remove note on how to start Redis on Windows/WSL
2023-04-05 08:51:38 +02:00
Chocobozzz
00ee545c24
Remove $ for bash commands
It prevents easy copy
2023-04-04 09:18:06 +02:00
Chocobozzz
11c834bdba
Add server code new feature walkthrough 2023-03-16 14:15:33 +01:00
Chocobozzz
f44cd95c01
Update doc anchor links 2023-02-23 09:46:43 +01:00
Chocobozzz
c5c95361e6
Move to new documentation links 2023-02-22 16:15:14 +01:00
Chocobozzz
efaf379789
Fix dev instance following test instances 2023-02-17 10:28:33 +01:00
Chocobozzz
f8deb7982c
Fix redoc cli command 2023-02-17 10:10:22 +01:00
Chocobozzz
f11d8a8380
Update contributing guide 2023-02-17 09:14:00 +01:00
Chocobozzz
29ff788963
Add contributing guide for embed 2023-02-16 16:47:13 +01:00
Chocobozzz
1f26c0b846
Add openapi doc guide in documentation 2023-02-16 16:41:32 +01:00
Chocobozzz
2fcd3cbf02
Update contributing guide 2023-02-09 12:16:42 +01:00
Jelle Besseling
d342d752b3 Add info about running redis server 2022-09-19 08:53:37 +02:00
Chocobozzz
edd7b1256b
Add info on dev env variables 2022-07-07 08:27:27 +02:00
Chocobozzz
9452d4fd33
/!\ Use a dedicated config file for development
It means you have to replace NODE_ENV=test to NODE_ENV=dev if you use it
npm run dev:* commands are already updated
2022-07-06 16:12:17 +02:00
thecashewtrader
85cba7f1f0 Fix broken links in contributing guideline 2022-01-14 09:15:59 +01:00
Chocobozzz
820299121f
Run doctoc on contributing guide 2021-11-02 10:15:06 +01:00
Chocobozzz
9883e60f30
Improve tests documentation 2021-11-02 10:13:53 +01:00
Chocobozzz
4f97f58383
Update PR template and contributing guide 2021-06-25 14:55:25 +02:00
Chocobozzz
27bc958674
Bidi support 2021-06-07 18:14:05 +02:00
kontrollanten
05e85b59c7
contributing documentation: add parallel as dependency (#3421)
Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-12-07 21:27:25 +01:00
Rigel Kent
afff310e50 allow private syndication feeds via a user feedToken 2020-11-25 11:07:56 +01:00
Frank Sträter
b4bc269e55
fix CONTRIBUTING.md command order (#3305) 2020-11-13 11:53:30 +01:00
Chocobozzz
93ab83893d
Fix npm run test 2020-11-10 15:04:08 +01:00
Rigel Kent
a3e6d18199
slightly reword CONTRIBUTING doc 2020-08-10 12:01:50 +02:00
Chocobozzz
17b07dc5a2 Update contributing guide 2020-07-10 14:02:41 +02:00
Chocobozzz
6676056a31
Add max count information in api doc 2020-05-13 11:31:42 +02:00
Chocobozzz
0ceadb3578
Use absolute links in contribute guide 2020-05-13 11:25:04 +02:00
Chocobozzz
e5426b3fa4
Update test contributing guide 2020-02-12 10:36:37 +01:00
Chocobozzz
297e911bdb
Use node 10 in travis 2019-07-25 11:25:45 +02:00
Chocobozzz
bfa1a32b34
Add client hook/register typings 2019-07-24 11:55:08 +02:00
Nassim Bounouas
50b4dcce56 Fix/connection with email (#1917)
* #1916 Load user by email - insensitive query

* Revert "Case insensitive login"

This reverts commit c1521ca3d7.

* #1916 Load user - insensitive query for username and sensitive for email

* #1916 Unit test for insensitive username login && documentation
2019-07-02 11:16:33 +02:00
Jorropo
b30acc0e4b Update contributing to use multiple remote. (#1902)
Using multiple remote simplify a lot updating and pulling.
2019-06-14 10:40:01 +02:00
Nicolas Fortin
838f4a7983 fix-contributing-documentation-client-side-typo
Fixing a small typo in the contributing documentation.
The project seems really promising, love it :)
2019-06-04 23:33:46 +02:00
buoyantair
e6b04e0e79 tell the user to fork the repo (#1856)
* tell the user to fork the repo

very small doc bug :)

* fix link
2019-05-30 09:00:10 +02:00
Chocobozzz
46e9407c60
Update URLs to point to new documentation site 2019-05-23 14:58:34 +02:00
Jan Keromnes
0cfcbae818 Add automated dev setup using Gitpod 2019-04-12 09:25:43 +02:00
Chocobozzz
9ba1d64b1a
Update CONTRIBUTING.md 2019-04-04 16:37:18 +02:00
Rigel Kent
e2266e4f82
update CONTRIBUTING.md to reflect new documentation sections 2018-11-09 14:51:08 +01:00
Thomas Kuntz
0e62b72bb9 Add 'Improve the website' section to CONTRIBUTING (#1366) 2018-11-03 15:00:10 +01:00
Rigel Kent
71607e4a65
fix typo in CONTRIBUTING.md 2018-10-24 23:39:52 +02:00
Aurélien Béranger
e730aef76a (doc) add VPS as development platform example in CONTRIBUTING.md (#1278) 2018-10-24 00:16:47 +02:00
Clément Brizard
80c7336a89 (doc) explain common watcher inotify error in CONTRIBUTING.md (#1223) 2018-10-08 13:25:41 +02:00
am97
a43e21820d add warning about RAM to contributing guide (#1112) 2018-09-23 14:50:24 +02:00
Felix Ableitner
dd07afa5f4 Add missing instructions to Contributing document 2018-08-23 09:41:25 +02:00
Chocobozzz
6a1787c127
Add translation guide 2018-06-21 14:07:53 +02:00
Chocobozzz
dbe868c070
Add note about instance config in contributing guide 2018-06-08 10:53:33 +02:00
Chocobozzz
6cca7360eb
Reduce bundle sizes 2018-06-07 16:50:33 +02:00
Chocobozzz
6d492e562c
Fix contributing guide concerning unit tests 2018-04-20 11:53:56 +02:00