Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.27 KB

README.md

File metadata and controls

82 lines (59 loc) · 3.27 KB

CI scan codecov Maintainability

https://defiscan.live

DeFi Scan, everything one-stop location for DeFi Blockchain. Powered by DeFi Jellyfish & ocean network.

Developing & Contributing

Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along the way to make it mergeable. Here are some of our documented contributing guidelines.

We use npm 7 for this project, it's required to set up npm workspaces.

npm install --include=dev

Getting started

First, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

About Next.js

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

Project Structure

scan/
├─ .github/
├─ content/
├─ public/
├─ src/
│  ├─ components/
│  ├─ layouts/
│  ├─ pages/
│  │  ├─ slugs/*.tsx
│  │  └─ index.tsx
│  ├─ store/
│  └─ styles/

DeFi Scan project is structured with 2 core directories. Each pull request will likely carry significant changes into those directories.

Directory Description
/.github workflow for shift left automation
/content static code based content management system with type safety
/public static resources
/src/components top level components for a shared design language
/src/layouts top level layouts for shared page layout & components
/src/pages each page is associated with a route based on its file name
/src/store global state that is used in at least more than once
/app/styles tailwind css style configuration

Security issues

If you discover a security vulnerability in DeFi Scan, please see submit it privately.

License & Disclaimer

By using DeFi Scan (this repo), you (the user) agree to be bound by the terms of this license.