coding-resources-api/index.html at main · maddyali/coding-resources-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Coding Resources API</title>

    <!-- STYLES -->
    <link rel="stylesheet" type="text/css" href="public/css/normalize.css" />
    <link rel="stylesheet" type="text/css" href="public/css/style.css" />
    <!-- ICONS -->
    <link
      rel="stylesheet"
      href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
      integrity="sha512-iecdLmaskl7CVkqkXNQ/ZH/XLlvWZOJyj7Yy7tcenmpD1ypASozpmT/E0iPtmFIB46ZmdtAc9eNBvH0H/ZpiBw=="
      crossorigin="anonymous"
      referrerpolicy="no-referrer"
    />
  </head>
  <body>
    <div class="container">
      <header>
        <a href="/" id="title">coding resources api</a>
        <nav>
          <ul>
            <li><a href="#about">about</a></li>
            <li><a href="#docs">docs</a></li>
          </ul>
        </nav>
      </header>

      <main>
        <h1>
          The
          <span class="dark-text"
            >Coding <br />
            Resources</span
          >
          API
        </h1>
        <div class="split">
          <section id="about" class="about">
            <h2>Description</h2>
            <p>
              This API serves educational resources relevant to software
              engineering. You can search for coding resources using relevant
              keywords.
            </p>
          </section>

          <section class="test-api">
            <h2>Try it out</h2>
            <form action="">
              <input type="text" placeholder="keyword" id="keyword-input" />
              <button id="keyword-btn" type="button">
                <i class="fa-solid fa-magnifying-glass"></i>
              </button>
            </form>
            <div class="result">
              <div class="scroll-container">
                <ul id="result-list">
                  <li>
                    <code class="json">
                      {
                      <p>name: 'example',</p>
                      <p>url: 'example',</p>
                      <p>description: 'example',</p>
                      <p>keywords: ['example']</p>
                      }
                    </code>
                  </li>
                </ul>
              </div>
            </div>
          </section>
        </div>
      </main>

      <section id="docs" class="docs">
        <h2>Documentation</h2>
        <section class="obj-keys">
          <h3>There are 3 keys that come with each resource object:</h3>
          <table>
            <thead>
              <tr>
                <th>Key</th>
                <th>Value</th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td>name</td>
                <td>[String] Name or title of resource</td>
              </tr>
              <tr>
                <td>url</td>
                <td>[String] Link to website</td>
              </tr>
              <tr>
                <td>keywords</td>
                <td>
                  [Array] Relevent keywords related to the resource's topic
                </td>
              </tr>
            </tbody>
          </table>
        </section>

        <section class="endpoints">
          <h3>Endpoints</h3>
          <div class="split">
            <div>
              <h4>
                Directly access entire array of resource objects or filter it by
                using a keyword:
              </h4>
              <code>https://the-coding-resources-api.up.railway.app/api</code>
              <h5>
                *The '/api' endpoint returns an array of all resource objects.
              </h5>
              <code
                >https://the-coding-resources-api.up.railway.app/api/<span
                  class="dark-text"
                  >&lt;keyword&gt;</span
                >
              </code>
              <h5>
                *The '/api/keyword' endpoint filters the resources array based
                on a keyword and returns an array of matching resource objects.
              </h5>
            </div>

            <div>
              <h4>Example code-block of how to fetch using JavaScript:</h4>
              <img
                src="/public/assets/js-fetch.png"
                alt="Example code-block of how to fetch using JavaScript."
                id="js-fetch"
              />
            </div>
          </div>
        </section>
      </section>

      <footer>
        <div class="split">
          <div class="contact">
            <img
              src="/public/assets/headshot.png"
              alt="Headshot"
              id="headshot"
            />
            <div class="contact-body">
              <h4>ali the techie</h4>
              <ul class="social-links">
                <li>
                  <a
                    href="https://www.instagram.com/alithetechie"
                    target="_blank"
                    ><i class="fa-brands fa-instagram"></i
                  ></a>
                </li>
                <li>
                  <a href="https://www.linkedin.com/in/maddyali" target="_blank"
                    ><i class="fa-brands fa-linkedin-in"></i
                  ></a>
                </li>
                <li>
                  <a href="https://github.com/maddyali" target="_blank"
                    ><i class="fa-brands fa-github"></i
                  ></a>
                </li>
              </ul>
            </div>
          </div>

          <div class="message">
            <p>
              Bugs? Features? Please report them
              <a
                href="https://github.com/maddyali/coding-resources-api/issues"
                target="_blank"
              >
                <span class="dark-text">here</span>.</a
              >
            </p>
          </div>
        </div>
      </footer>
    </div>
    <script src="/public/js/main.js"></script>
  </body>
</html>