Initial commit

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+	root: true,
+	extends: [
+		'plugin:@typescript-eslint/recommended',
+		'plugin:@next/next/recommended',
+		'plugin:tailwindcss/recommended',
+		'plugin:prettier/recommended',
+		'prettier',
+	],
+	parser: '@typescript-eslint/parser',
+	rules: {
+		'padding-line-between-statements': [
+			'error',
+			{ blankLine: 'always', prev: '*', next: 'return' },
+		],
+	},
+};

.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.nvmrc

@@ -0,0 +1 @@
+20

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+	printWidth: 80,
+	semi: true,
+	singleQuote: true,
+	tabWidth: 4,
+	useTabs: true,
+};

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## How to contribute to this workshop demo
+
+#### **Did you find a bug?**
+
+-   Fill in new [GitHub issue](https://github.com/oss-institute/workshop-template/issues).
+
+-   **Ensure the bug was not already reported**.
+
+-   If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/oss-institute/workshop-template/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch for existing bug or issue?**
+
+-   Open a new GitHub pull request with the patch.
+
+-   Ensure the PR description clearly describes the problem and solution. Include the relevant issue number.
+
+-   Before submitting, make sure both `lint` and `tests` are passing.
+
+-   In case you added a new functionality, always add a new test. This does not apply for visual changes (cosmetic changes, typos, updates in styles).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Open Source Software Institute z.ú.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# <img src="./src/app/icon.png" alt="OSS logo" style="width:25px;"/> OSS Workshop demo project
+
+This is a demo project used for learning purposes, it is part of Open Source Software Institute workshop.
+
+The application is based on a [Next.js](https://nextjs.org/) project.
+
+## Getting Started
+
+Install all the dependencies and run the server
+
+```sh
+npm i
+
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the built project.
+
+## Styling
+
+For styling, repository is using [Tailwind css](https://tailwindcss.com). You can check global variables and colors definition in [global.css](https://github.com/oss-institute/workshop-template/blob/master/src/app/globals.css), theme is defined in [tailwind.config.ts](https://github.com/oss-institute/workshop-template/blob/master/tailwind.config.ts).
+
+## Deployment
+
+All pull requests are automatically deployed to ###. You can see the running version of the master branch >here<

jest.config.ts

@@ -0,0 +1,26 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {
+	collectCoverage: true,
+	collectCoverageFrom: ['<rootDir>/src/**/*.{ts,tsx}'],
+	coverageProvider: 'v8',
+	coveragePathIgnorePatterns: ['layout.tsx'],
+	testEnvironment: 'jsdom',
+	transform: {
+		// Use babel-jest to transpile tests with the next/babel preset
+		// https://jestjs.io/docs/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object
+		'^.+\\.(ts|tsx)$': ['babel-jest', { presets: ['next/babel'] }],
+		'^.+\\.(png)$': 'jest-transform-stub',
+	},
+	transformIgnorePatterns: [
+		'/node_modules/',
+		'^.+\\.module\\.(css|sass|scss)$',
+	],
+};
+
+export default config;

next.config.mjs

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;