Xandao.dev

Xandão.dev

My personal website! For you to know more about me and my work.

Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Recommended IDE Setup
   • Installation
3. Front-end Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Features

• Bio
• Projects

Built With

• Vue.js 3 - A progressive framework for web development
• Svelte - A compiler for writing reactive code
• TypeScript - Typed superset of JavaScript
• Tailwind CSS - A utility-first CSS framework

Getting Started

To get a local copy up and running follow these simple steps.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Installation

1. Clone the repo

   git clone https://github.com/xandao-dev/xandao.dev.git
   

2. Install frontend dependencies

    cd xandao.dev/frontend
    pnpm install
   

   Front-end Usage

• Starts the development server

  cd frontend
  pnpm dev
  

• Build for production

  cd frontend
  pnpm build-core
  pnpm build-libs
  

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Free software =)

Contact

Alexandre Calil - Linkedin - alexandre@xandao.dev

Project Link: https://github.com/xandao-dev/xandao.dev

Acknowledgements

• Web components
• eslint - code linter
• prettier - code formatter
• pnpm - performant npm alternative with workspace support