Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.92 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.92 KB

andronix-internal-api

What is this? ⚡

This is the repository of the official website for Andronix App. This combines billing for the digital products that Andronix offers and Andronix Commands.

Andronix Commands will be added soon to this repo. It currently resides on here and is build with just VueJS and Tailwind.

What is the Tech-Stack? 📐

This website/web-app is built using NuxtJS and Tailwind. Deployed on Netlify and uses GitHub Actions for the app pipeline.

- Testing 🤖

We use Cypress for our E2E automated tests. Our unit and integration tests are done through Mocha and Chai.

Developer Notes

How to run it locally? 🏠

Clone the project and assuming that you have NodeJS installed on your machine already, run -

# yarn
yarn run dev # for the development server. 
yarn run generate # for the production build. 

# npm
npm run dev # for the development server. 
npm run generate # for the production build. 

How do I contribute? 🏗

If you want to improve something or maybe add something new, you can just send a pull request and if that's something that we would like to add/change, we'll be more than happy to merge it.