Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .env.example

This file was deleted.

51 changes: 51 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: CI

on:
push:
branches: [main]
pull_request:

jobs:
frontend:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm run lint -w frontend
- run: npm test -w frontend
- run: npm run build -w frontend

backend:
runs-on: ubuntu-latest
services:
mongo:
image: mongo:7
ports: ["27017:27017"]
env:
MONGODB_TEST_URI: mongodb://localhost:27017/authentick_test
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm run lint -w backend
- run: npm test -w backend
- run: npm run build -w backend

contracts:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
- run: npm ci
- run: npm run lint -w contracts
- run: npm test -w contracts
34 changes: 15 additions & 19 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# Node modules
/node_modules
node_modules/
dist/
coverage/
.env
.env.*
!.env.example
.vercel/
*.log
.DS_Store

# Compilation output
/dist

# pnpm deploy output
/bundle

# Hardhat Build Artifacts
/artifacts

# Hardhat compilation (v2) support directory
/cache

# Typechain output
/types

# Hardhat coverage reports
/coverage
# hardhat
contracts/artifacts/
contracts/cache/
contracts/types/
contracts/ignition/deployments/
contracts/deployedAddresses.json
38 changes: 0 additions & 38 deletions ARCHITECTURE.md

This file was deleted.

16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ First off, thank you for considering contributing to AuthenTick! It's people lik
1. **Fork the repository** on GitHub.
2. **Clone your fork** locally:
```bash
git clone https://github.com/your-username/authentick.git
cd authentick
git clone https://github.com/Phantom8420/AuthenTick.git
cd AuthenTick
```
3. **Set up the upstream remote**:
```bash
git remote add upstream https://github.com/your-org/authentick.git
git remote add upstream https://github.com/Phantom8420/AuthenTick.git
```

## 🛠️ Development Environment
Expand All @@ -23,17 +23,19 @@ We use a mono-repo structure with npm workspaces. To install all dependencies ac
npm install
```

Make sure you copy `.env.example` to `.env` and configure any necessary external credentials (such as your Firebase settings or Gemini keys).
Copy `backend/.env.example` to `backend/.env` if you want to change the defaults. Without MongoDB the API uses an in-memory store, so this is enough to start:
```bash
npm run dev
```

You can run the entire local testing stack (including the database) with:
Before opening a pull request, run everything CI runs:
```bash
npm run dev:stack
npm run lint && npm test && npm run build
```

## 🧑‍💻 Code Style & Standards

- **TypeScript Standard**: We use TypeScript across the entire off-chain stack. Ensure you compile successfully before committing (`npm run lint`).
- **Formatting**: Please adhere to the configured Prettier formatting standard.
- **Smart Contracts**: Solidity files should adhere strictly to standard conventions; run `npm run test:contracts` to ensure all tests pass. Maintain security standard methodologies using standard OpenZeppelin extensions.
- **Commit Messages**: We encourage conventional commit messages (e.g., `feat: Add ZK Verifier`, `fix: Patch metadata ingestion bug`).

Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 AuthenTick contributors

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.
Loading
Loading