Skip to content

Commit

Permalink
Add photos into handbook.
Browse files Browse the repository at this point in the history
  • Loading branch information
@boushrabettir
boushrabettir authored Oct 7, 2023
1 parent a3f507d commit 0a8453b
Showing 1 changed file with 45 additions and 27 deletions.
72 changes: 45 additions & 27 deletions handbook.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
Welcome to the official acmOpportunities handbook! Here will be a detailed tutorial on how to set up all the technical aspects.

## Step 1 - Install Python & Fork Repository
Make sure to install Python before we continue [here!](https://www.python.org/downloads/).
Make sure to install Python before we continue [here!](https://www.python.org/downloads/)

Once you're done, go ahead and fork this repository.

## Step 2 - Setting up
You have **MANY** environment variables to set up. Let's go through each one and discuss how to get the information for them!
We have **MANY** environment variables to set up. Let's go through each one and discuss how to get the information for them!

### Job/Internship URL's
Here, we have the following variables:
Expand All @@ -20,24 +20,28 @@ As you can see, the `GH_INTERN24_URL` is already populated for you.
To populate the LinkedIn URL's please go ahead and search up your type of job.
In this example, we will search up `Software Engineer` for `LINKEDIN_URL` and `Software Engineer Intern` for `LINKEDIN_INTERN_URL`.

Go ahead and copy the link at the top and paste it into the variable names.
![Alt text](image.png)
1. Go ahead and copy the link at the top and paste it into the variable names.

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/ba582896-fa9b-4674-bc39-29593d5cdfd3)


### PaLM
Here, we have the following variable:
```py
PALM_API_KEY=""
```
If you haven't already, please sign up for access for [MakerSuite](https://makersuite.google.com/).
**If you haven't already, please sign up for access for [MakerSuite](https://makersuite.google.com/).**

1. Click this button on the left once you're ready.

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/38c71365-4e5d-4fb9-ab9c-8f0d40ef49b7)

Click this button on the left once you're ready.
![Alt text](image-1.png)
2. Now, click the left button called `Create API key in new project` and **copy** you key.

Now, click the left button called `Create API key in new project` and **copy** you key.
![Alt text](image-2.png)
![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/36f5971c-94d4-4440-93f8-5f90a1197a78)

Paste your key into the **PALM_API_KEY** enviornment variable.

3. Paste your key into the **PALM_API_KEY** enviornment variable.

### Prompt Path
Here, we have the following variable:
Expand All @@ -48,8 +52,8 @@ Depending on your bot's purpose, you might want to send notifications related to

We offer the following:
```
**Computer Science** - /prompts/cs.json
**CyberSecurity** - /prompts/cybersecurity.json
Computer Science - /prompts/cs.json
CyberSecurity - /prompts/cybersecurity.json
```

**If you do not see your type, please create an issue and we will add it in.**
Expand All @@ -61,8 +65,9 @@ MESSAGE_PATH=""
```
You are able to customize the styling of your message!
The default styling is the following:
`[**{company}**]({link}): {title} `@{location}`!`
![Alt text](image-3.png)
`[**{company}**]({link}): {title} @{location}!`
![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/7ef73b63-d61e-4751-85af-6077798cbe81)


Go ahead and customize it how you like in `./msg/message.json`.
**If you would like the default styling, you can leave that file untouched.**
Expand All @@ -75,16 +80,24 @@ DISCORD_WEBHOOK=""
Now that we've taken care of the basic setup, it's time to configure our bot. In this project, we utilize Discord webhooks, which serve as a means of communication, allowing various programs to seamlessly transmit messages within a Discord chat. This streamlines the process of receiving updates and notifications from multiple sources, all conveniently located in one central location.

1. Click **Server Settings**
![Alt text](image-4.png)

2. Click **Integrations**
![Alt text](image-5.png)
![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/b8a94fb2-8571-43ce-b770-c3fa2165289a)


2. Click **Integrations**

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/85f4bf36-0845-4fe6-a0ca-a3035e959df1)


3. Click **New Webhook**

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/aab8f1fc-0354-4300-9196-8cbbd081fe52)

3. Click **Create a Webhook**
![Alt text](image-6.png)

4. Create a new webhook and **copy the url**
![Alt text](image-7.png)

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/cb4a9d04-23c4-4304-a831-46427f2d2e2e)

*If necessary, you have the flexibility to adjust the channel where your Discord bot sends its messages to suit your preferences.*

Add that link into the `DISCORD_WEBHOOK` enviornment variable.
Expand All @@ -98,20 +111,25 @@ DB_TABLE="opportunities_table"

As you can see, your database table name is already given to you. You can change it to however you like.

To set up your table in your database, please refer to the [follow documentation](https://www.elephantsql.com/docs/index.html) for it. **Do not create a table, we will do that here.**
1. To set up your table in your database, please refer to the [follow documentation](https://www.elephantsql.com/docs/index.html) for it. **Do not create a table, we will do that here.**

2. After you've set yours up, naviagte to `Details` and please copy paste the URL into the `DB_URI`.

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/4af9524c-a61b-447e-86ae-67658a0c1fa7)

After you've set yours up, please copy paste the URL into the `DB_URI`.
![Alt text](image-8.png)

## Step 3 - Install Dependencies
Pip install the dependencies of main.py using `pip install -r requirements.txt`.

## Step 4 - Create Table in your Database
To create the table, write `python ./main --create` **once** in the terminal.
![Alt text](image-9.png)
1. To create the table, write `python ./main --create` **once** in the terminal.

![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/97d521af-7444-4f32-90f8-75b5afe6df35)


2. If you go back to your database and click **Browser** and **Table Queries** you should see your newly made table.

If you go back to your database and click **Browser** and **Table Queries** you should see your newly made table.
![Alt text](image-11.png)
![image](https://github.com/acmcsufoss/acmOpportunities/assets/116927138/757ef7b0-bd3d-4eb6-b4ad-d02d30bb2659)

## Step 5 - Final Steps
Congratulations! The discord bot will now send in opportunities **every other day**.
Expand Down

0 comments on commit 0a8453b

Please sign in to comment.