https://github.com/fairdataihub/fairshare-auth

Authentication service for FAIRshare
https://github.com/fairdataihub/fairshare-auth

Last synced: 9 months ago
JSON representation

Authentication service for FAIRshare

• Host: GitHub
• URL: https://github.com/fairdataihub/fairshare-auth
• Owner: fairdataihub
• License: mit
• Created: 2022-08-15T18:19:20.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-17T17:50:00.000Z (over 2 years ago)
• Last Synced: 2025-02-08T18:26:41.080Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://auth.fairshareapp.io
• Size: 1.43 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# FAIRshare Authentication Service

[![CodeFactor](https://www.codefactor.io/repository/github/fairdataihub/fairshare-auth/badge)](https://www.codefactor.io/repository/github/fairdataihub/fairshare-auth)

![Checkly Status](https://api.checklyhq.com/v1/badges/checks/938427be-1b3d-4519-a5a4-3ad3c94fea3d?style=flat&theme=default)

![Checkly Response Time](https://api.checklyhq.com/v1/badges/checks/938427be-1b3d-4519-a5a4-3ad3c94fea3d?style=flat&theme=default&responseTime=true)

## Project setup

Make sure to install the dependencies.

```bash

yarn install

```

### Compiles and hot-reloads for development

Start the development server on http://localhost:3000

```bash

yarn dev

```

### Compiles and minifies for production

Use this step to build a local production version of the site. Use `start` to preview the local build.

```bash

yarn build

yarn start

```

### How to use

### Requirements

- Node.js >= 16.14.0

- Yarn 1 (Classic)

### Directory Structure

- [`.github`](.github) — GitHub configuration including the CI workflow.


- [`.husky`](.husky) — Husky configuration and hooks.


- [`public`](./public) — Static assets such as robots.txt, images, and favicon.


- [`pages`](./src/pages) — Application source code, including pages, components, styles.

### Scripts

- `yarn dev` — Starts the application in development mode at `http://localhost:3000`.

- `yarn build` — Creates an optimized production build of your application.

- `yarn start` — Starts the application in production mode.

- `yarn type-check` — Validate code using TypeScript compiler.

- `yarn lint` — Runs ESLint for all files in the `src` directory.

- `yarn format` — Runs Prettier for all files in the `src` directory.

### Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the `@` prefix.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.

Note: You will not need to do anything to the hosted site. Continuous Delivery has been setup with Vercel. All you need to do is push your commit and wait for it to deploy.

## Acknowledgements

A special thank you to Vercel for hosting this project.