Skip to content

Commit 9c4b83d

Browse files
relaxedtomatoRam Bansal
and
Ram Bansal
authored
Use Readme.md instead of Setup.md (#159)
* - update readme with content from setup - remove setup, we should be using the updated readme * shift java error to individual readmes --------- Co-authored-by: Ram Bansal <[email protected]>
1 parent fb086d3 commit 9c4b83d

File tree

7 files changed

+15
-43
lines changed

7 files changed

+15
-43
lines changed

README.md

+5-28
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Explore working front-end and back-end sample code using an integration with Nylas.
1010

11-
The sample application redirects to a prebuilt authentication page hosted on Nylas, then allows that authenticated user to interact with Nylas API from a web client.
11+
The sample applications redirect to the Nylas hosted authentication page. Once a user authenticates, it allows them to interact with the Nylas APIs from a web client.
1212

1313
Before you get started, head over to your Quickstart Application on the Nylas Dashboard for a copy of your `client id` and `client secret`. You'll need those later in the demo.
1414

@@ -36,36 +36,13 @@ If choosing a `python` backend for your demo application, please make sure you h
3636
python3 --version
3737
```
3838

39-
## ⚡️ App Setup
39+
## ⚡️ App Set up
4040

41-
1. Installation
41+
View the `README.md` files in the `backend` and `frontend` directories for instructions on how to set up the server and client. These README files include set up instructions for each language.
4242

43-
```bash
44-
git clone nylas-samples@use-cases
43+
Start the backend server first, then in a new terminal, start the frontend server.
4544

46-
cd use-cases
47-
48-
npm install
49-
50-
npm run prep:husky // only needed if contributing to the repo
51-
```
52-
53-
2. Copy `.env.sample` to `.env` on the root level of the project.
54-
3. Fill in the `NYLAS_CLIENT_ID` and `NYLAS_CLIENT_SECRET` in `.env` file
55-
56-
```js
57-
// Nylas application credentials
58-
NYLAS_CLIENT_ID = '<NYLAS_CLIENT_ID> from the Nylas Dashboard';
59-
NYLAS_CLIENT_SECRET = '<NYLAS_CLIENT_SECRET> from the Nylas Dashboard';
60-
```
61-
62-
4. Run code
63-
64-
```bash
65-
# in one terminal
66-
npm start # starts server + opens browser for localhost:3000
67-
# terminal shows webhook output here
68-
```
45+
Once the servers are running, visit the app at [http://localhost:3000](http://localhost:3000). You can also visit the backend server at [http://localhost:9000](http://localhost:9000).
6946

7047
## 💙 Contributing
7148

SETUP.md

-15
This file was deleted.

packages/read-and-create-calendar-events/backend/java/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Start the backend server before you start the frontend. You will need two termin
5555
./gradlew run
5656
```
5757

58+
On MacOS, if you experience this error `./gradlew build # fails due to permission error`, run this command first: `chmod 755 gradlew`
59+
5860
**Windows (PowerShell)**
5961

6062
```bash

packages/read-emails/backend/java/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Start the backend server before you start the frontend. You will need two termin
5555
./gradlew run
5656
```
5757

58+
On MacOS, if you experience this error `./gradlew build # fails due to permission error`, run this command first: `chmod 755 gradlew`
59+
5860
**Windows (PowerShell)**
5961

6062
```bash

packages/schedule-events/backend/java/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Run one of the following commands to install the Java dependencies for this samp
3333
./gradlew build
3434
```
3535

36+
On MacOS, if you experience this error `./gradlew build # fails due to permission error`, run this command first: `chmod 755 gradlew`
37+
3638
**Windows (Powershell)**
3739

3840
```bash

packages/send-and-read-emails/backend/java/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Run one of the following commands to install the Java dependencies for this samp
3333
./gradlew build
3434
```
3535

36+
On MacOS, if you experience this error `./gradlew build # fails due to permission error`, run this command first: `chmod 755 gradlew`
37+
3638
**Windows (Powershell)**
3739

3840
```bash

packages/send-emails/backend/java/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Run one of the following commands to install the Java dependencies for this samp
3333
./gradlew build
3434
```
3535

36+
On MacOS, if you experience this error `./gradlew build # fails due to permission error`, run this command first: `chmod 755 gradlew`
37+
3638
**Windows (Powershell)**
3739

3840
```bash

0 commit comments

Comments
 (0)