Skip to content

Commit

Permalink
Merge branch 'main' into feature/donatorContract
Browse files Browse the repository at this point in the history
  • Loading branch information
EmmanuelAR committed Aug 13, 2024
2 parents 98a22a7 + 8698e2c commit 7a27702
Show file tree
Hide file tree
Showing 24 changed files with 467 additions and 7 deletions.
22 changes: 15 additions & 7 deletions .github/workflows/contract_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,19 @@ jobs:
with:
filters: |
contracts_dir:
- 'src/**'
- 'contracts/src/**'
- name: Install scarb
if: steps.changes.outputs.contracts_dir == 'true'
run: curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
run: |
cd contracts
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
- name: Run scarb fmt
if: steps.changes.outputs.contracts_dir == 'true'
run: scarb fmt
run: |
cd contracts
scarb fmt
check-contracts-changes:
runs-on: ubuntu-latest
Expand All @@ -36,12 +40,16 @@ jobs:
with:
filters: |
contracts_dir:
- 'src/**'
- 'contracts/src/**'
- name: Install scarb
if: steps.changes.outputs.contracts_dir == 'true'
run: curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
run: |
cd contracts
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
- name: Run scarb check
if: steps.changes.outputs.contracts_dir == 'true'
run: scarb check
run: |
cd contracts
scarb check
115 changes: 115 additions & 0 deletions CONTRIBUTORS_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Contributor Guidelines

🎉 Thank you for being interested in contributing to the Gostarkme project! 🎉

Feel welcome and read the following sections in order to know how to ask questions and how to work on something.

Please make sure you are welcoming and friendly in all of our spaces.

We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏

## Issues

The best way to contribute to our projects is by opening a new issue <a href="https://github.com/web3wagers/gostarkme/issues/new" target="_blank">Here</a> or tackling one of the issues <a href="https://github.com/web3wagers/gostarkme/issues" target="_blank">listed here</a> .

# Pull Requests

1. When picking up an issue give a brief presentation about yourself.

```
Template:
Hi, I'm [Your Name] and I'll be working on issue #[Issue Number].
I estimate this will take [Time Estimate] to complete.
```

2. **Estimated Time to Completion**: Approximate number of hours or days required to complete the task.

3. **Approach and Methodology**: Briefly outline your strategy for tackling the issue, including any relevant tools, technologies, or resources you plan to utilize

4. Fork the repo and create a new branch for your issue in the forked repo learn more about how to fork a repository<a href="https://github.com/web3wagers/gostarkme/issues" target="_blank"> here</a>

5. When modifying contracts kindly make sure the formatting is correct and all tests pass successfully.

6. Commit your changes.

7. Push to your fork and submit a pull request on our `dev` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.

## CI (Github Actions)

We use GitHub Actions to verify if the code of your PR passes all our checks.

When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.

## Commits

We use Conventional Commits to add human and machine readable meaning to our commit messages. In particular, we use the Angular convention.

Don't worry if it looks complicated. In our repositories, after adding your files with git (i.e `git add`), you can just run the `commit` script in our `package.json`, and you'll be prompted to fill out any required commit fields at commit time. We use Commitizen under the hood.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

The header is mandatory and the scope of the header is optional.

## Type

The type must be one of the following:

- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
- perf: A code change that improves the performance
- test: Adding missing or correcting existing tests
- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
- chore: Other changes that don't modify src or test files
- revert: Reverts a previous commit

### Scope

The scope could be anything specifying place of the commit change. In a monorepo, it could be the name of the package or project affected.

### Subject

The subject contains a succinct description of the change:

Use the imperative, present tense: "change" not "changed" nor "changes".
Don't capitalize the first letter.
No dot (.) at the end.
Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behaviour.

### Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behaviour.

## Branches

1. There must be a `main` branch, used only for the releases.
2. There must be a `dev` branch, used to merge all the branches under it.
3. Avoid long descriptive names for long-lived branches.
4. Use kebab-case (no CamelCase).
5. Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
6. Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
7. Use slashes to separate parts of your branch names.
8. Remove your branch after merging it if it is not important.

Examples:

```
git branch -b docs/readme
git branch -b test/a-feature
git branch -b feat/sidebar
git branch -b fix/b-feature
```
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Go Stark Me is a modern platform designed to make fundraising for important caus

Join us on Go Stark Me and make a difference by supporting meaningful projects in a secure and efficient manner.

## Our Vision for UI

You can check the prototype we have in mind and suggest any improvement, if you feel capable of reproducing some of the pages please contact one of the product owners.

- [Figma prototype](https://www.figma.com/design/SCiGViaoPT9UTrT7CsLbAt/Go-Stark-Me?node-id=0-1&t=FUhnIhNcXRIGkQ16-1)

## Contributors

- [EmmanuelAR](https://github.com/EmmanuelAR)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
36 changes: 36 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
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).

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

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.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
3 changes: 3 additions & 0 deletions frontend/gostarkme-web/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
38 changes: 38 additions & 0 deletions frontend/gostarkme-web/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 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

/package-lock.json
Binary file added frontend/gostarkme-web/app/favicon.ico
Binary file not shown.
33 changes: 33 additions & 0 deletions frontend/gostarkme-web/app/globals.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
@tailwind base;
@tailwind components;
@tailwind utilities;

:root {
--foreground-rgb: 0, 0, 0;
--background-start-rgb: 214, 219, 220;
--background-end-rgb: 255, 255, 255;
}

@media (prefers-color-scheme: dark) {
:root {
--foreground-rgb: 255, 255, 255;
--background-start-rgb: 0, 0, 0;
--background-end-rgb: 0, 0, 0;
}
}

body {
color: rgb(var(--foreground-rgb));
background: linear-gradient(
to bottom,
transparent,
rgb(var(--background-end-rgb))
)
rgb(var(--background-start-rgb));
}

@layer utilities {
.text-balance {
text-wrap: balance;
}
}
22 changes: 22 additions & 0 deletions frontend/gostarkme-web/app/layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import type { Metadata } from "next";
import { Inter } from "next/font/google";
import "./globals.css";

const inter = Inter({ subsets: ["latin"] });

export const metadata: Metadata = {
title: "Create Next App",
description: "Generated by create next app",
};

export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en">
<body className={inter.className}>{children}</body>
</html>
);
}
Loading

0 comments on commit 7a27702

Please sign in to comment.