diff --git a/.env.example b/.env.example index 40d1099..21c560f 100644 --- a/.env.example +++ b/.env.example @@ -1 +1,2 @@ NEXT_PUBLIC_BACKEND_URL="http://127.0.0.1:9000/woc/api/v1" +NEXT_PUBLIC_THEME="SUMMER" \ No newline at end of file diff --git a/README.md b/README.md index 23761d8..e55c3fa 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ -# Summer of Code Leaderboard +# Season of Code Platform -This repository contains the code-base to the LIVE leaderboard for `Amrita Summer of Code`@`ACM Amrita`. +This repository contains the codebase to the `Amrita Season of Code (AmSoC)` platform, an open source contribution challenge organised by the `Amrita ACM Student Chapter` to encourage participation in open source development. -### Technical Stack -- The application is written in **Next.js** on top of **TypeScript**. The framework was chosen as it happened to be the most comfortable one at the disposal of the developers at the time of writing. +Two themes have been developed for the event so far - `Winter` and `Summer`. The theme can be switched via the `NEXT_PUBLIC_THEME` environment variable along with some minor code changes, like updating the subtext and swapping between `blue-400` and `yellow-400` here and there... + +![summer](/public/summer-theme/summer-theme-screenshot.png) +![winter](/public/winter-theme/winter-theme-screenshot.png) + +## Technical Stack +The application is written in **Next.js** on top of **TypeScript**. The framework was chosen as it happened to be the most comfortable one at the disposal of the developers at the time of writing. + +## Getting Started ### Prerequisites Before setting up the project, ensure you have the following installed on your machine: @@ -11,7 +18,7 @@ Before setting up the project, ensure you have the following installed on your m - **Node.js** (version 16 or higher) - **pnpm** (version 7 or higher) -### Setup Steps +### Setup Follow these steps to set up the project locally after cloning the repository: 1. Install dependencies: @@ -19,21 +26,22 @@ Follow these steps to set up the project locally after cloning the repository: pnpm install ``` -2. Create a copy of the `.env` file: +2. Create the `.env` file in the root directory: + ```bash + cp .env.example .env + ``` -3. Run the development server: +3. Configure the theme variable in `.env`: + ``` + NEXT_PUBLIC_THEME=WINTER # Allowed: SUMMER or WINTER + ``` + +4. Run the development server: ```bash pnpm run dev ``` -### Contribution Guidelines -- Write descriptive git commit messages. -- Write clear descriptions in pull requests for quicker merging. +## Contribution Guidelines -### Authors -- [Kiran Rajeev KV](https://github.com/KiranRajeev-KV) -- [Vijay SB](https://github.com/vijaysb0613) -- [Ritesh Koushik](https://github.com/IAmRiteshKoushik/) -- [Ashwin Narayanan S](https://github.com/Ashrockzzz2003) - -> For any queries, please reach out to us on our socials or via email. +- Write descriptive git commit messages. +- Write clear descriptions in Pull Requests (PRs) for quicker merging. diff --git a/public/summer-theme/summer-theme-screenshot.png b/public/summer-theme/summer-theme-screenshot.png new file mode 100644 index 0000000..49bced8 Binary files /dev/null and b/public/summer-theme/summer-theme-screenshot.png differ diff --git a/public/winter-theme/winter-theme-screenshot.png b/public/winter-theme/winter-theme-screenshot.png new file mode 100644 index 0000000..6ce00eb Binary files /dev/null and b/public/winter-theme/winter-theme-screenshot.png differ