Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: ♻️ codefair to Codefair standardization #32

Merged
merged 108 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
02c7971
wip: :construction: auth
slugb0t Apr 26, 2024
aff2b57
Merge remote-tracking branch 'origin/main' into auth
slugb0t Apr 26, 2024
2eb2561
wip: :construction: auth
slugb0t Apr 26, 2024
7aabc17
wip: :construction: implementing authentication
slugb0t Apr 26, 2024
cd920e4
merge: merge conflicts resolved from main
slugb0t Apr 29, 2024
2f29409
wip :construction: sending user to client
slugb0t Apr 29, 2024
558a65f
🐛 fix: update probot to esm (#11)
megasanjay Apr 29, 2024
767fa9c
refactor: :recycle: update pnpm-lock file
slugb0t Apr 29, 2024
9daa45a
wip: :construction: ensure validated session returns user/session
slugb0t May 1, 2024
210e455
refactor: :recycle: update pnpm lock file
slugb0t May 1, 2024
5b66ff7
fix: :bug: mongodb adapter returns user
slugb0t May 1, 2024
3b4bf89
✨ feat: add license ui (#12)
megasanjay May 1, 2024
82ad2f6
feat: :sparkles: profile page + fix on existing user sessions
slugb0t May 1, 2024
1f7b6bc
🚧 fix: auth (#13)
megasanjay May 2, 2024
384e981
✨ feat: add base pages and auth (#14)
megasanjay May 8, 2024
a22d81e
✨ feat: update layout
megasanjay May 8, 2024
4eefc9b
🚨 chore: fix the linters
megasanjay May 8, 2024
0403f64
✨ feat: add an error component
megasanjay May 8, 2024
9096884
🐛 fix: use built in error component instead
megasanjay May 9, 2024
8afa783
🐛 fix: editor list styling
megasanjay May 9, 2024
7987714
🐛 fix: add explanation text
megasanjay May 9, 2024
986fc51
🐛 fix: route to home on login
megasanjay May 9, 2024
4bc2107
✨ feat: add support for license creation
megasanjay May 9, 2024
9be6635
🔀 merge main into auth
megasanjay May 9, 2024
d0f9bc7
🚨 fix: linter fixes
megasanjay May 9, 2024
00d42be
🔨 chore: update ping
megasanjay May 14, 2024
e43ac73
feat: ✨ issue redesign (#16) (#15)
megasanjay May 31, 2024
c3971eb
refactor: :recycle: update middleware
slugb0t May 31, 2024
fa9b48c
🚚 wip: test path
megasanjay May 31, 2024
ef6ed53
🚚 wip: test path
megasanjay May 31, 2024
1c83cd0
🚚 wip: test path
megasanjay May 31, 2024
c2e2456
🚚 wip: test path
megasanjay May 31, 2024
1ac8378
🚚 wip: test path
megasanjay May 31, 2024
048135a
🚚 wip: test path
megasanjay May 31, 2024
b0bda50
🚚 wip: test path
megasanjay May 31, 2024
27153cc
refactor: :recycle: downgrade probot
slugb0t Jun 4, 2024
8d6dd33
refactor: :recycle: update api imports
slugb0t Jun 4, 2024
a284d4e
refactor: :recycle: explicitly call github app credentials
slugb0t Jun 4, 2024
fe4d55a
dev: :memo: update gitignore
slugb0t Jun 6, 2024
cf2450b
feat: :sparkles: run probot programatically
slugb0t Jun 6, 2024
83b8356
feat: :sparkles: run probot v12 on a server
slugb0t Jun 6, 2024
75079f8
feat: ✨ metadata UI + probot workflow (#23)
slugb0t Jun 14, 2024
31d90d3
refactor: :recycle: remove validate button from codemeta section
slugb0t Jun 14, 2024
9c03294
Staging (#24)
megasanjay Jun 14, 2024
4611d53
👷 ci: use node 20 in nixpacks
megasanjay Jun 17, 2024
6025771
fix: :bug: replace nanoid
slugb0t Jun 17, 2024
0eff9cd
fix: :bug: remove port
slugb0t Jun 17, 2024
5ed6ed8
refactor: :recycle: determine master branch within context
slugb0t Jun 17, 2024
f4bbec1
✨ feat: add support for login redirects
megasanjay Jun 17, 2024
6559d0c
refactor: ♻️ Bot feedback (#25)
slugb0t Jun 20, 2024
4023c23
feat: :sparkles: Display link to repo on license editor
slugb0t Jun 20, 2024
13ad0a0
🐛 fix: update ui and fix access token (#26)
megasanjay Jun 20, 2024
434695b
refactor: :recycle: update on badge buttons
slugb0t Jun 24, 2024
66f1509
refactor: :recycle: add url to codemeta section
slugb0t Jun 24, 2024
3736362
refactor: :recycle: About section updated
slugb0t Jun 24, 2024
49cc495
refactor: :recycle: strictly open links in new tab
slugb0t Jun 25, 2024
0a0acd2
refactor: :recycle: remove redirect
slugb0t Jun 25, 2024
695aae9
feat: :sparkles: analytics collection for db
slugb0t Jun 25, 2024
861643b
refactor: :recycle: save license content + id upon push to repo
slugb0t Jun 25, 2024
cca5c85
feat: :sparkles: save license content and id upon push to repo
slugb0t Jun 25, 2024
90201cd
style: :art: rounded and shadow to dashboard cards
slugb0t Jun 26, 2024
1566280
refactor: :recycle: update on the github dashboard
slugb0t Jun 27, 2024
901cc58
fix: :bug: grammar fix on title dashboard
slugb0t Jun 27, 2024
7231235
refactor: :recycle: update to the code meta ui
slugb0t Jun 27, 2024
be1d01b
refactor: :recycle: hide editorial section of codemeta:
slugb0t Jun 28, 2024
2b59858
refactor: :recycle: update on license UI
slugb0t Jun 28, 2024
4a54b9b
refactor: :recycle: updates
slugb0t Jun 28, 2024
2e3e001
refactor: :recycle: timestamps formatted to human readable format
slugb0t Jun 28, 2024
a808d22
👷 ci: add support for webhook based deployments (#27)
megasanjay Jul 4, 2024
a06c886
💚 ci: add pnpm to the ci env
megasanjay Jul 4, 2024
9b5f6da
💚 ci: remove unused item
megasanjay Jul 4, 2024
edbf96b
✨ feat: add beta tag to dashboard
megasanjay Jul 4, 2024
fe5851e
✨ feat: add a contact form
megasanjay Jul 4, 2024
f8ee3cc
feat: ✨ Dashboard UI Changes + License and Codemeta.json extraction (…
slugb0t Jul 7, 2024
33a1830
dev: :construction_worker: update pnpm-lock file
slugb0t Jul 7, 2024
83c610d
feat: :sparkles: remove repo from installation collection upon uninst…
slugb0t Jul 7, 2024
1c2efcf
feat: :sparkles: event listener for alternate method of uninstallation
slugb0t Jul 7, 2024
3c23bd7
fix: :bug: metadata import with empty values
slugb0t Jul 7, 2024
fb58742
fix: :bug: buffer license content with base64
slugb0t Jul 7, 2024
45fd98c
feat: :sparkles: help links added to metadata and license page
slugb0t Jul 8, 2024
00c6377
feat: :sparkles: coming soon zenodo card
slugb0t Jul 9, 2024
e447164
refactor: :recycle: subheader for zenodo card
slugb0t Jul 9, 2024
3f93a15
Merge branch 'staging' of https://github.com/fairdataihub/codefair in…
slugb0t Jul 10, 2024
430a65e
💄 style: update ui
megasanjay Jul 11, 2024
e535302
feat: ✨ theme change + general UI updates (#29)
slugb0t Jul 11, 2024
8f01881
feat: :sparkles: healthcheck added to bot
slugb0t Jul 11, 2024
52bdb98
refactor: :recycle: update healthcheck endpoint
slugb0t Jul 11, 2024
3633311
feat: :sparkles: nixpacks config file
slugb0t Jul 11, 2024
572c7d1
refactor: :recycle: move toml file
slugb0t Jul 11, 2024
16d601f
refactor: :recycle: add packagemananger in package.json
slugb0t Jul 11, 2024
28c515e
refactor: :recycle: move toml
slugb0t Jul 11, 2024
c3a3728
refactor: :recycle: testing dockerfile update
slugb0t Jul 11, 2024
f7498d5
refactor: :recycle: update toml
slugb0t Jul 11, 2024
a8fc176
👷 ci: disable secondary deployment
megasanjay Jul 11, 2024
7896513
refactor: :recycle: specify node version in package.json
slugb0t Jul 11, 2024
1d61ce9
Merge branch 'staging' of https://github.com/fairdataihub/codefair in…
slugb0t Jul 11, 2024
0b4b1ff
refactor: :recycle: delte files
slugb0t Jul 11, 2024
c4b2c1e
👷 ci: disable secondary deployment
megasanjay Jul 11, 2024
bb5cd38
refactor: :recycle: hide bg image until finalized
slugb0t Jul 11, 2024
e86c527
Merge branch 'staging' of https://github.com/fairdataihub/codefair in…
slugb0t Jul 11, 2024
1f37c08
refactor: :recycle: node version
slugb0t Jul 11, 2024
af7b37d
feat: :sparkles: need help links direct to documentation
slugb0t Jul 11, 2024
fa120e7
Merge branch 'main' into staging
slugb0t Jul 11, 2024
b394fb7
fix: :bug: nav bar links
slugb0t Jul 11, 2024
08d2efc
Merge branch 'staging' of https://github.com/fairdataihub/codefair in…
slugb0t Jul 11, 2024
0020670
Update README.md
slugb0t Jul 11, 2024
2f3ab1d
refactor: :recycle: spelling normalization for codefair
slugb0t Jul 11, 2024
fc09d51
refactor: dashboard issue text updates
slugb0t Jul 11, 2024
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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,17 @@ Your coding assistant to make research software reusable without breaking a swea

## Description

Codefair is your personal assistant when it comes to making your research software reusable and especially complying with the [Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software](https://doi.org/10.1038/s41597-022-01710-x). Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, codefair is here to assist you. By communicating with you through GitHub issues and submitting pull requests, codefair will make sure that your software follows best coding practices, provides metadata in standard format, includes a license file, is archived on Zenodo, and much more. With codefair by your side, you're not just developing software but you're advocating for better software practices. Learn more on the app's website [codefair.io](https://codefair.io/).
Codefair is your personal assistant when it comes to making your research software reusable and especially complying with the [Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software](https://doi.org/10.1038/s41597-022-01710-x). Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, Codefair is here to assist you. By communicating with you through GitHub issues and submitting pull requests, Codefair will make sure that your software follows best coding practices, provides metadata in standard format, includes a license file, is archived on Zenodo, and much more. With Codefair by your side, you're not just developing software but you're advocating for better software practices. Learn more on the app's website [codefair.io](https://codefair.io/).

![screenshot of the License issue up to where is it closed with the PR](https://imgur.com/fcOuzTC.png)

## Getting started

### Installing

1. Install codefair from the [GitHub market place](https://github.com/marketplace/codefair-app) on the GitHub organizations or repositories of your choice
1. Install Codefair from the [GitHub market place](https://github.com/marketplace/codefair-app) on the GitHub organizations or repositories of your choice
2. Code as usual
3. Track FAIR compliance issues through the codefair issue dashboard and address them through the codefair website.
3. Track FAIR compliance issues through the Codefair issue dashboard and address them through the Codefair website.

> [!NOTE]
> While Codefair is free, installing it via the GitHub Marketplace may still require a credit card to be associated with your (or your organization’s) GitHub account. To circumvent this requirement, you can alternatively install Codefair directly from the [app page](https://github.com/apps/codefair-app).
Expand Down Expand Up @@ -97,10 +97,10 @@ cd ui
pnpm dev
```

## How codefair is developed
## How Codefair is developed

Codefair is developed using Probot and is deployed on Vercel as a serverless function. The GitHub app is configured to receive webhooks for important actions such as pushing code, opening or closing issues, opening or merging pull requests and commenting on discussions.
By leveraging a serverless environment on Vercel, codefair can automatically scale to handle the workload of the GitHub app. The app is written in Node.js and utilizes the Octokit library to interact with the GitHub APIenabling seamless integration with GitHub's features and functionality.
Codefair is developed using Probot and is deployed on a server as a serverless function. The GitHub app is configured to receive webhooks for important actions such as pushing code, opening or closing issues, opening or merging pull requests and commenting on discussions.
By leveraging a serverless environment on a server, Codefair can automatically scale to handle the workload of the GitHub app. The app is written in Node.js and utilizes the Octokit library to interact with the GitHub APIenabling seamless integration with GitHub's features and functionality.

## Contributing

Expand Down Expand Up @@ -144,7 +144,7 @@ If you are using this package or reusing the source code from this repository fo
<div align="center">

<a href="https://codefair.io">
<img src="https://raw.githubusercontent.com/fairdataihub/codefair-app/main/public/assets/images/codefair_logo_name.png" alt="logo" width="200" height="auto" />
<img src="https://raw.githubusercontent.com/fairdataihub/codefair-app/main/ui/public/assets/images/codefair_logo_name.png" alt="logo" width="200" height="auto" />
</a>

</div>
Loading
Loading