How to Set Up and Contribute to Github.ist Web Application

September 18, 2020

Welcome to the world of Github.ist! This guide will walk you through the process of installing, starting, and contributing to the Github.ist web application. Buckle up as we take you through each step in a user-friendly manner.

Installation

Before we dive in, make sure you have yarn installed on your computer. Here’s how to get everything up and running:

Open your terminal and navigate to the project directory.
Run the following command to install dependencies:

yarn

Copy the sample environmental variables file:

cp .env.sample .env

Update the newly created .env file with actual values you want to use.

Starting the Application

Now that we have everything set up, it’s time to launch the application!

In the terminal, run:

yarn start

A browser window should pop up, allowing you to see the development server in action!

Isolated Development with Storybook

One of the amazing features of this project is isolating component development using Storybook. Think of it as a gallery where all your components can live, allowing you and others to view and test them in various states. Here’s how to launch it:

Run the following command in your terminal:

yarn run storybook

Your Storybook server will be available at http://0.0.0.0:6006. Here you can interact with your components and see how they function.

Contributing to Github.ist

Excited to contribute a new feature? Awesome! Follow these steps to ensure a smooth contribution process:

Fork the repository to your account.
As you develop a component or utility function, make sure to include thorough tests for them.
Place all tests in the same folder as the file you are testing.
Always verify your code with linters by running:

yarn lint

Format your code; this will be done automatically at commit time, but you can do it manually as follows:

yarn format

Run your tests to ensure everything works correctly.
Push your branch to your remote repository.
Finally, open a Pull Request and assign relevant reviewers.

Note: After adding any new package to the application, execute:

yarn flow-typed-install

This command ensures that the flow-type definitions for the new packages are incorporated or adds stubs to the application.

Troubleshooting

If you encounter issues during installation or running the application, here are some suggestions:

Ensure that yarn is properly installed and added to your PATH.
Double-check the contents of your .env file for any incorrect values.
If Storybook is not running, verify that the command was typed correctly and that all dependencies installed without errors.
If you experience issues with tests, consider running each command step manually to identify where it might be failing.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.