The /src folder contains core source code needed for frontend development.
The server.js file is responsible for initial set up of the backend and the /api folder contains core source code needed for API/backend development.
- Clone the repo
git clone https://github.com/setlife-network/trinary
- Install packages
cd trinary
npm install
- Copy the sample environment configuration file
cp .env.example .env
-
Obtain a
.envfile from a project maintainer or fill out your own values -
Run the UI server
npm run ui
- Open a new Terminal tab and run the web server
npm run server
// or for hot-reloaded backend code
npm run dev-server
-
UI should open in the browser at
localhost:6002 -
An API Explorer is accessible in the browser at
localhost:6001/api/graph
If using VSCode, be sure to disable the Prettier: Format on Save feature to prevent unwanted changes to the code styles.
If you want to set up a local database, follow these steps or follow this tutorial:
-
Download and install MySQL server (Usually it comes with others features like Workbench).
-
To connect to the server open the command prompt or shell and type the next command:
shell> mysql -h host -u user -p
Enter password: ********To disconnect you can use this commands:
mysql> QUIT
Bye- To create a database use this command:
mysql> CREATE DATABASE setLife;
- To select the created database use this command:
shell> mysql -h host -u user -p setLife- If you want to show all the created databases use this command:
mysql> SHOW DATABASES;-
To use the created database in the Trinary project, you need to setup your enviroment variables file also known as
.envfile, an example file is available in the code called.env.example, copy the code inside this file into a new one named.envon the main path of the project. -
After the
.envfile is created, fill in the variables that start withMYSQL_DBwith your own values after the equal sign.
e.g.
MYSQL_DB_HOST=127.0.0.1
- With all database variables filled you can run the
npm run serverornpm run dev-servercommand and the necessary tables will be created.
If you are encountering an error that says: "react scripts start is not recognized as an internal or external command," or any related error with dependencies, upon running "npm start" or "npm ui" within terminal, run the following command:
npm update
Wait for the update, and it should be back to normal.
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
To learn more about Sequelize and how proceed to create migrations, check out the following resources
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify