|
1 |
| -# Learning Platform |
| 1 | +This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). |
2 | 2 |
|
3 |
| -A place for the CSESoc community to learn and share their knowledge and expertise. |
| 3 | +## Getting Started |
4 | 4 |
|
5 |
| -> 🌈 **Status update:**<br> Currently adding MDX support via @next-mdx-remote! Rationale [here](https://compclub.atlassian.net/wiki/spaces/CW/pages/2217771174/Decision+Matrix%3A+MDX+Integration). |
| 5 | +First, run the development server: |
6 | 6 |
|
7 |
| -## Motivation |
| 7 | +```bash |
| 8 | +npm run dev |
| 9 | +# or |
| 10 | +yarn dev |
| 11 | +``` |
8 | 12 |
|
9 |
| -At CSESoc, CSE students gather to socialise and extend their technical knowledge outside the classroom. Educational content has previously been delivered via workshops. However, this limits people who're uncomfortable with holding workshops, or want to contribute on a smaller scale, from contributing. Having a platform where students of various backgrounds can contribute to the collective knowledge of their community is critical to its success. Hence, the CSESoc Learning Platform! |
| 13 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
10 | 14 |
|
11 |
| -By opening up new formats of contributing such as **articles**, **videos** and **sample projects**, we hope that this empowers more people to share what they've learned with the wider CSE community. |
| 15 | +You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. |
12 | 16 |
|
13 |
| -## Code style |
| 17 | +[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. |
14 | 18 |
|
15 |
| -Prettier is used for code formatting. |
| 19 | +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. |
16 | 20 |
|
17 |
| -## Screenshots |
| 21 | +## Learn More |
18 | 22 |
|
19 |
| -Check the [Figma canvas](https://www.figma.com/file/BikvnEQenQQnuDw8YVH07b/Learning-Platform---Mockups?node-id=120%3A2) out! The design may change. |
| 23 | +To learn more about Next.js, take a look at the following resources: |
20 | 24 |
|
21 |
| -## Tech stack |
| 25 | +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
| 26 | +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
22 | 27 |
|
23 |
| -Built with Next.js and React. |
| 28 | +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! |
24 | 29 |
|
25 |
| -## Features |
| 30 | +## Deploy on Vercel |
26 | 31 |
|
27 |
| -_Coming soon_ |
| 32 | +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
28 | 33 |
|
29 |
| -## Installation |
30 |
| - |
31 |
| -1. Clone this repo |
32 |
| -2. `yarn install` to install all dependencies |
33 |
| -3. `yarn dev` to start the local server |
34 |
| - |
35 |
| -## Our team |
36 |
| - |
37 |
| -We're CSESoc Education! Development is currently led by: |
38 |
| - |
39 |
| -- [Maxwell Phillips](https://github.com/maxphillipsdev) |
40 |
| -- [Jeffrey Yao](https://github.com/jeffreydyao) |
41 |
| -- [Gordon Huang](https://github.com/dqna64) |
42 |
| -- [Jasper Di Francesco](https://github.com/jasperdifran) |
| 34 | +Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |
0 commit comments