Skip to content

Commit 799585b

Browse files
author
kim
committed
docs: update gitlocalized and update readme
1 parent 701d91f commit 799585b

File tree

1 file changed

+5
-84
lines changed

1 file changed

+5
-84
lines changed

README.md

Lines changed: 5 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,9 @@
1-
<div style="margin-bottom: 20px; display:flex; justify-content: center; align-items: center ">
2-
<img style="text-align: center" src="https://graasp.org/favicon.svg" width=100 >
3-
</div>
1+
# Chatbot App
42

5-
# Graasp App Template
6-
7-
This repository hosts the template code for a **Graasp App** written with [Typescript](https://www.typescriptlang.org/) and [React](https://react.dev/). The bundler used is [Vite](https://vitejs.dev).
8-
9-
<div style="gap:10px; display:flex; justify-content: center; align-items: center;">
10-
<img src="https://upload.wikimedia.org/wikipedia/commons/4/4c/Typescript_logo_2020.svg" width=50 >
11-
<span>+</span>
12-
<img src="https://upload.wikimedia.org/wikipedia/commons/a/a7/React-icon.svg" width=50 >
13-
<span>+</span>
14-
<img src="https://upload.wikimedia.org/wikipedia/commons/f/f1/Vitejs-logo.svg" width=50 >
15-
<span>=</span>
16-
<span>❤️</span>
17-
</div>
18-
19-
## Using this template
20-
21-
The recommended way to use this template is with the [Graasp CLI](https://github.com/graasp/graasp-cli) which provides a setup wizard and some convenience tools when creating your project.
22-
23-
Alternatively it is possible to create a new Github repo from this project using the Github Template function. In this case the local setup is left as an exercice to the reader.
24-
25-
### With the Graasp CLI
26-
27-
This template can be used with the [graasp CLI](https://www.npmjs.com/package/@graasp/cli?activeTab=readme) to setup your project in a single line:
28-
29-
```bash
30-
npx @graasp/cli@latest new -s graasp/graasp-app-starter-ts-vite
31-
```
32-
33-
The CLI will ask you a few questions to help you setup your project. It suggests sane defaults:
34-
35-
- Deploying using GitHubActions (recommended)
36-
- Provide an appId
37-
- Auto-install project dependencies
38-
- Initialize a local git repository
39-
40-
<details >
41-
<summary><h3>Directly from GitHub</h3></summary>
42-
43-
Should you choose to bootstrap your graasp app manually, you will need to execute the following steps.
44-
45-
#### Cloning the template
46-
47-
Get a copy of this repo.
48-
49-
##### Using the Template button
50-
51-
Click on the `Use this template` button. For more instructions head over to the [GitHub Docs on Using a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
52-
53-
##### Clone from the command line
54-
55-
With `git`:
56-
57-
```sh
58-
git clone
59-
```
60-
61-
With the [GitHub CLI](https://cli.github.com/):
62-
63-
```bash
64-
gh repo clone graasp/graasp-app-starter-ts-vite
65-
```
66-
67-
#### Adding Workflows
68-
69-
To deploy your app using github actions.
70-
71-
#### Renaming
72-
73-
You will have to look for the `Graasp App Template` string in yours project files and rename it to your project name
74-
75-
</details>
76-
77-
### GitHub Repo setup
78-
79-
If you choose to deploy your app with the provided GitHubActions workflows you will need to create the following secrets:
80-
81-
- `APP_ID`: a UUID v4 that identifies your app for deployment
82-
- `APP_KEY`: a UUID v4 that authorizes your app with the Graasp API
83-
- `SENTRY_DSN`: your Sentry url to report issues and send telemetry
84-
85-
## Installation
3+
<a href="https://gitlocalize.com/repo/9564/fr?utm_source=badge"> <img src="https://gitlocalize.com/repo/9564/fr/badge.svg" /> </a>
4+
<a href="https://gitlocalize.com/repo/9564/de?utm_source=badge"> <img src="https://gitlocalize.com/repo/9564/de/badge.svg" /> </a>
5+
<a href="https://gitlocalize.com/repo/9564/it?utm_source=badge"> <img src="https://gitlocalize.com/repo/9564/it/badge.svg" /> </a>
6+
<a href="https://gitlocalize.com/repo/9564/es?utm_source=badge"> <img src="https://gitlocalize.com/repo/9564/es/badge.svg" /> </a>
867

878
## Running the app
889

0 commit comments

Comments
 (0)