Dev StartGuide

開発者用スタートガイド / Start Guide for Developers

This is a start guide for the development of "im pact" itself or actions and tweet filters.

Or, do you want to just use it? It's easy, please see the Start Guide for Users.

---

Setup your development environment

0. Install requirements on PC

• Node.js v16 (LTS)

• Docker Desktop with Docker Compose

• Visual Studio Code

1. Fork our repository

Firstly, please fork our repository using "Fork" button at the top right of this page. After that, the forked repository has appeared as a repository of yours.

2. Clone your repository

$ git clone git@github.com:YOUR-USER-NAME/im-pact.git
$ cd im-pact/

3. Install dependencies on Local

$ npm install --legacy-peer-deps

NOTE: The development environment runs inside a Docker Compose container. However, Installation of dependencies is required also to your local as follows, to enable autocomplete, formatting, and Linter in the editor (Visual Studio Code).

4. Launch the development server and the database servers

$ sudo docker-compose up -d
$ npm run start:dev

NOTE: You need to execute the above two commands above in succession. The first command launches the PostgreSQL database server and others administration tools for the database. The second command launches the app by enabling logging.

5. Open the web browser on Local

Open the web browser (We recommend using Google Chrome), and navigate to http://localhost:4200/

6. What's next?

• Basic information about development:
  • Development of TweetFilters -- Let's create your Tweet Filter to improve the extraction of tweets.
  • Development of Actions -- Would you like to create your Action to improve the approval process? share tweet to other services? make statistics? or... ?
  • Testing -- You can also create automated tests to improve reliability.
• Others:
  • FAQ

---

Home