Skip to content

achamorro-dev/eventoswiki

Repository files navigation


Icon

eventos.wiki

all technological events in one place

Sponsored by

About The Project

Eventos.wiki

back to top

Getting Started

Prerequisites

This project has been created and configured to work with the pnpm package manager so it's recommended to install this tools.

This project also is configured using volta. You can install this tool to ensure that you are using the correct versions of node and npm.

Anyway this project should work with the following versions:

  • node >= 18.17.0
  • npm >= 9.6.7

If you have node and npm running properly on your side you can execute the following command to install pnpm globally:

npm install -g pnpm

Tools and libraries used

Installation

To install the required dependencies you should be execute the following command:

pnpm i --frozen-lockfile

back to top

Run

To run the application in develop mode (in your local machine enabling hot reload) you can use:

npm run dev

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

back to top

License

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

back to top

Contact

Alberto Chamorro - albertochamorro.dev

back to top