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-15Lines changed: 5 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,39 +2,29 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
2
2
3
3
## Getting Started
4
4
5
-
First, run the development server:
5
+
To run the development server, you must first install node modules
6
6
7
7
```bash
8
+
npm install
8
9
npm run dev
9
10
# or
11
+
yarn install
10
12
yarn dev
11
13
# or
14
+
pnpm install
12
15
pnpm dev
13
16
```
14
17
15
18
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
16
19
17
-
18
-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/](http://localhost:3000/api/).
19
-
20
-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
21
-
22
20
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
23
-
24
-
This project requires an env for the following variables:
25
-
```bash
26
-
LDAP_API_KEY
27
-
JIRA_API_KEY
28
21
```
29
22
30
-
## Project Structure
23
+
## Project Structure
31
24
32
25
`pages/index.js` is where the form for user input is generated. It uses the `components` directory to generate more complex
33
26
dropdowns.
34
27
35
-
`pages/api/form.js` is the only API route in this project. It is responsible for taking the user input and generating the
36
-
appropriate JQL query to send to the JIRA API. It also uses the [LDAP API](https://github.com/uvarc/ldap-api) to get the department and school for the visitor.
37
-
38
28
## TO DO
39
29
40
30
Currently, assignees for the JIRA ticket are hard-coded as a list inside of `index.js`. This should eventually be abstracted to some other service, or generated from an API call to JIRA.
0 commit comments