https://github.com/rocketchat/rc.guided.tours
Graphical Guided RC Codebase Tours
https://github.com/rocketchat/rc.guided.tours
Last synced: 3 months ago
JSON representation
Graphical Guided RC Codebase Tours
- Host: GitHub
- URL: https://github.com/rocketchat/rc.guided.tours
- Owner: RocketChat
- Created: 2024-07-30T05:58:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-26T04:48:56.000Z (11 months ago)
- Last Synced: 2025-09-29T01:40:00.307Z (3 months ago)
- Language: TypeScript
- Size: 861 KB
- Stars: 30
- Watchers: 2
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RC.Guided.Tours for Rocket.Chat
RC.Guided.Tours aims to provide a smooth on-boarding process of new contributors to Rocket.Chat codebase. We use VsCode extension `CodeTour` to explain the most crucial parts of the codebase so that new contributors can start contributing as quickly as possible. methods.
# Quick Start 🚀
1. You need a Rocket.Chat Server [Setup](https://developer.rocket.chat/v1/docs/server-environment-setup) (You dont need a running server)
2. Install the [CodeTour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) extension in VsCode
3. `cd Rocket.Chat` and execute (Use nodejs 14)
```bash
curl -s https://raw.githubusercontent.com/RocketChat/RC.Guided.Tours/main/setup.sh | bash
```
4. If you don't want to contribute, just press `Enter` (For contributing see below)
https://github.com/user-attachments/assets/fe8ad250-7a72-40ee-85c2-f7ae6b06b68e
### You are Good to go!! 🔥
## Want to Contribute? 👀
- Fork this repo https://github.com/RocketChat/RC.Guided.Tours
- Enter the link of your forked repository in terminal, Instead of doing step 4. (Example- https://github.com/Sayan4444/RC.Guided.Tours.git)
- To perform any git actions related to [RC.Guided.Tours](https://github.com/Sayan4444/RC.Guided.Tours), always
```bash
cd RC.Guided.Tours
```
Since we use nested .git folders, never perform a git action related to [RC.Guided.Tours](https://github.com/Sayan4444/RC.Guided.Tours) from outside the folder.
## Tours Available
| **S no.** | Tour |
|:--------------------|:-------------------|
| 01 | Rocket.Chat Onboarding |
| 02 | Understanding Monorepo Structure of Rocket.Chat |
| 03 | Repository Overview |
| 04 | How to send a message (Client Side) |
| 05 | How to send a message (Server Side) |
| 06 | How to create an endpoint |
| 07 | How to create a DB model |
| 08 | How to use DB model |
| 09 | Services in Rocket.Chat |
| 10 | How to Add a new Services |
| 11 | How to create a new Package |
## Development Guidelines 👨🏽💻
- Make changes in the `src` folder and then execute
```bash
npm run dev
```
to see your changes in effect. This internally calls the `build` `tours` scripts inside RC.Guided.Tours
- When choosing a `searchString` make sure its `short` and `unique`. Avoid using `function arguments` as searchString.
#### Running the project
Starting Tours:- Use `ctrl+shift+p` / `cmd+shift+p` to open all commands and then select the `start tour` option
[](https://github.com/user-attachments/assets/44e2be20-43ea-4eb7-941d-e05aeaa8f95a)
## Working Architecture 👀
- We are using a nested git architecture, where the child repository is git ignored by the parent repository and both have a seperate git history
- To git ignore, we are not changing the .gitignore file but adding the file `.git/info/exclude` which can be called as a local git extension of the .gitignore file.
- `RC.Guided.Tours` is a standalone package which runs seperately in the main repository.
- The `shell` script runs a `tours` script internally. This dynamically generates the `.tours` folder at the root directory of the folder which is responsible for visualizing the tours.
- The CodeTour Extension searches for a folder `.tours` and all the tours created are stored inside that folder in JSON format. To know more about the CodeTour extension visit [here](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour)
## Feedback
Please provide your honest feedback by joining this [channel](https://open.rocket.chat/channel/RC-Guided-Tours). You may write about these points
- Did this help you to understand the codebase?
- Were the examples and explainations easy to follow?
- Any further improvements or suggestions?
- Anything else you want to share with us
While setting up the project if you get an error `Search string not found` report this issue immediately in the above channel.