WisiIndie

wisi-indie.vercel.app

Contributing

Thank you for considering contributing to our open source project! We appreciate your interest and are excited to have you on board. This document outlines the steps you need to follow to contribute to the project effectively. Please read the guidelines carefully and feel free to reach out if you have any questions.

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)

Services

Before getting started, please ensure that you have the following third-party services set up:

• supabase: Go to the Database section to get started
• supabase: Authentication with Github

(back to top)

Getting Started

To install the project and its dependencies, follow these steps:

1. Make sure you have npm installed on your system. If not, you can install nvm (Node Version Manager) by running:

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

2. We will install the latest version of node lts we will use the --lts flag for the direct installation of the most current version with LTS

   nvm install --lts

3. Great, we already have it installed… now, to configure this version as the global version of our system:

   nvm use --lts

4. Run the following command to install the project dependencies:

   npm install

(back to top)

Database Preparation

Supabase

To prepare the Supabase database, follow these steps:

1. If you have not had any experience with Supabase, I highly recommend that you watch this basic video for Supabase, you will learn how to use the Supabase interface to create tables and manage the API. If not, you can skip this step and move on to the next one.

2. Create a project from scratch and save the Project URL and API Key keys for the environment variables in the .env file, you can leave this section for now to do that setup or go ahead and do it later no problem.

   

3. The next step would be to go to the table editor and create the necessary tables for the database following this structure: Be careful, this structure must be followed since there may be errors if any table is not correct.

3.1 Structure Table Ideas:

3.2 Structure Table User

With this you will have all the necessary tables for the database, now you can continue with the authentication and configuration of Email and Github providers.

Supabase Auth

To configure authentication on Supabase, follow these steps:

1. Go to the Authentication section
   
   

2. Go to the providers settings and make sure the Email provider is enabled and make sure to disable the Confirm Email option and make sure to save it.
   
   

2.1 You can see the Github provider configuration in the following link:

• supabase: Authentication with Github

(back to top)

Environment Variables

After configuring the necessary services, you must set the environment variables provided by supabase in the /.env.local file. To do this, follow these steps:

1. Pass your environment variables to the .env.example file
   
   

2. Finally change the .env.example to .env.local

(back to top)

Build

To build the project, execute the following command:

npm run build

Run

To run the project locally, use the following command:

npm run dev

Contact

Sebastian Terleira - Github - [email protected]

Camilo Torre - Github - [email protected]

(back to top)