Giter VIP home page Giter VIP logo

cored-mock's Introduction

✨ Cored Engine Dashboard ✨

Currently this template is not released yet, so please use it carefully.

Cored is a free and open-source admin dashboard, carefully crafted for your engine, powered by Vue 3!

  • Well-crafted components. All of the components are coded natively using SCSS pre-processors, so you can freely customize each components to your liking.
  • Modularized state management. Leveraging the power of Vuex 4.x, you can craft your state management solution based on your needs.
  • Typescript-ready. You can use the power of typescript to make your code typed to avoid type-related bugs of javascript.
  • Progressive Web Apps. You don't have to worry about whether the app is PWA-ready or not, because we put it in place for you!
  • Customizable. You can quickly build your dashboard by fully customising color themes, sizes according to your aesthetics!

Try live demo

🚀 Getting started

⏳ Installation

Clone the repo, and install all required dependencies to get started:

git clone https://github.com/alserembani94/corrad-mock.git
cd corrad-mock
npm install

// You can use yarn as well!
yarn add

After successfully cloned the project, you can run the project locally by run the serve command.

npm run serve

Visit http://localhost:8080 and enjoy! 🎉

To build the project, you can run the following command: npm run build.

🖐 Requirements

Supported operating systems:

  • Ubuntu LTS/Debian 9.x
  • CentOS/RHEL 8
  • macOS Mojave
  • Windows 10

(Please note that Cored may work on other operating systems, but these are not tested nor officially supported at this time.)

Node:

  • NodeJS >= 12.0
  • NPM >= 6.x

🌟 Features

  • Vue 3: We are using the latest Vue to serve you the latest feature offered in the market. For more information, you can visit Vue 3 documentation.
  • Typescript: Cored is built using Typescript, so you can comfortably type your code without having to worry about type-related bugs.
  • Modern Admin Panel: Elegant, minimalistic, entirely customizable components, crafted carefully using SCSS preprocessors. You can costumized it globally or at component level.
  • Vuex State Management: State management can be easily modularized to your needs! For more information on how to use Vuex 4, you can visit Vuex 4 documentation guide.

🙌 Contributing

Before Submitting a Pull Request

The core team will review your pull request and will either merge it, request changes to it, or close it.

Before submitting your pull request make sure the following requirements are fulfilled:

  • Fork the repository and create your branch from main.
  • If you’ve fixed a bug or added code that should be tested, add the tests and then link the corresponding issue in either your commit or your PR!
  • Make sure your code lints (npm run lint).

Contribution Prerequisites

  • You have Node at >= v12 and Yarn at v1.2.0+.
  • You are familiar with Git.

👨‍👩‍👧‍👦 Community support

Currently, we are still in initialization phase. As soon as it is completed, we will prepare channels for community support.

🔬 Roadmap

To make the collaboration more robust, we will prepare our roadmap so you can get along and contribute your ideas and follow our progress!

cored-mock's People

Contributors

alserembani94 avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.