You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-67Lines changed: 5 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ _What am I_
5
5
## Contributing
6
6
7
7
We are always open to contributions to the project. If you would like to contribute and want some guidance on where to start,
8
-
please join our [Discord](http://discord.utdnebula.com/) and ask for drop a message in the `#jupiter-general` channel or
9
-
DM Braedon for more details.
8
+
please join our [Discord](http://discord.utdnebula.com/) and ask for drop a message in the `#notebook-general` channel or
9
+
DM Shriram for more details.
10
10
11
11
Currently, we're tracking all issues via GitHub Issues. If you would like to work on an issue, please comment on the issue and we will assign it to you.
12
12
If you see anything that you think could be improved, please create an issue and we will look into it.
@@ -18,13 +18,13 @@ Please make sure you have at least [NodeJS v21.1.0](https://nodejs.org/en) or gr
18
18
Start by cloning the repository to your local machine.
Next, navigate to the project directory and install the dependencies.
25
25
26
26
```bash
27
-
cdjupiter
27
+
cdutd-notebook
28
28
npm install
29
29
```
30
30
@@ -44,72 +44,10 @@ or by running the following command in your terminal.
44
44
openssl rand -hex 32
45
45
```
46
46
47
-
Jupiter uses an ORM called [Drizzle](https://orm.drizzle.team/) to interact with the database. In order to connect to the database, you will need to add the `DATABASE_URL` variable to your `.env` file.
48
-
49
-
We're using Neon as our database provider. You can create a Neon account [here](https://neon.com/). Once you have created an account, you can create a new project and add the `DATABASE_URL` to your `.env` file. From a Neon project, you can find the `DATABASE_URL` by navigating to the `Dashboard` tab and clicking on the `Connect` button.
47
+
Jupiter uses an ORM called [Drizzle](https://orm.drizzle.team/) to interact with the database. In order to connect to the database, you will need to add the `DATABASE_URL` variable to your `.env` file. Your project lead will give this to you upon request.
50
48
51
49
The Nebula API is used for image storage. The `NEBULA_API_URL` variable should be set to `https://api.utdnebula.com/` and the `NEBULA_API_STORAGE_BUCKET` variable to `jupiter`. An API key and storage key should be requested from the project lead for the `NEBULA_API_KEY` and `NEBULA_API_STORAGE_KEY` variables.
52
50
53
-
#### Database Migrations
54
-
55
-
In your SQL editor, you will have to run a couple commands in order to properly set up the database
56
-
57
-
<details>
58
-
<summary>Nanoid</summary><br />
59
-
60
-
Run the following command to install the nanoid extension.
61
-
62
-
```sql
63
-
CREATE EXTENSION IF NOT EXISTS pgcrypto;
64
-
65
-
CREATE OR REPLACEFUNCTIONnanoid(size int DEFAULT 21, alphabet text DEFAULT '_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
Once you have added the `DATABASE_URL` to your `.env` file, and have all the necessary extensions, you will need to run the following commands to create the tables in your database.
106
-
107
-
```bash
108
-
npm run drizzle:push
109
-
```
110
-
111
-
These commands will create the tables in your database based on the models defined in the `src/server/db/schema.ts` directory. You would also run these commands anytime there are changes to `schema.ts` in order to update the database.
0 commit comments