{"id":13676772,"url":"https://github.com/TonyMckes/conduit-realworld-example-app","last_synced_at":"2025-04-29T07:33:23.100Z","repository":{"id":52194474,"uuid":"453400487","full_name":"TonyMckes/conduit-realworld-example-app","owner":"TonyMckes","description":"RealWorld example app, created to demonstrate a fully fledged fullstack application built with React / Express.js / Sequelize / PostgreSQL including CRUD operations, authentication, routing, pagination, and more.","archived":false,"fork":false,"pushed_at":"2024-08-06T12:27:24.000Z","size":2260,"stargazers_count":82,"open_issues_count":2,"forks_count":147,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-11T18:43:25.430Z","etag":null,"topics":["express","fullstack","javascript","nodejs","react","sequelize","showcase","vitest"],"latest_commit_sha":null,"homepage":"https://conduit-realworld-example-app.fly.dev/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TonyMckes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-29T13:08:19.000Z","updated_at":"2024-10-26T23:12:58.000Z","dependencies_parsed_at":"2024-01-14T14:31:09.291Z","dependency_job_id":"c3b56751-0d48-4cb1-ad49-2a8d50ced3a1","html_url":"https://github.com/TonyMckes/conduit-realworld-example-app","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TonyMckes%2Fconduit-realworld-example-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TonyMckes%2Fconduit-realworld-example-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TonyMckes%2Fconduit-realworld-example-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TonyMckes%2Fconduit-realworld-example-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TonyMckes","download_url":"https://codeload.github.com/TonyMckes/conduit-realworld-example-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251456058,"owners_count":21592285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["express","fullstack","javascript","nodejs","react","sequelize","showcase","vitest"],"created_at":"2024-08-02T13:00:32.728Z","updated_at":"2025-04-29T07:33:18.090Z","avatar_url":"https://github.com/TonyMckes.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# ![RealWorld Example App](logo.png)\n\n\u003e **React / Vite + SWC / Express.js / Sequelize / PostgreSQL codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://realworld.io/) spec and API.**\n\nThis codebase was created to demonstrate a fully fledged fullstack application built with **React / Vite + SWC / Express.js / Sequelize / PostgreSQL** including CRUD operations, authentication, routing, pagination, and more.\n\n**[Demo app](https://conduit-realworld-example-app.fly.dev/)\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;[With Create React App](https://github.com/TonyMckes/conduit-realworld-example-app/tree/create-react-app)\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;[Other RealWorld Example Apps](https://codebase.show/projects/realworld?category=fullstack)**\n\n\u003e For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.\n\n---\n\n## Getting Started\n\nThese instructions will help you install and run the project on your local machine for development and testing.\n\n### Prerequisites\n\nBefore you run the project, make sure that you have the following tools and software installed on your computer:\n\n- Text editor/IDE (e.g., VS Code, Sublime Text, Atom)\n- [Git](https://git-scm.com/downloads)\n- [Node.js](https://nodejs.org/en/download/) `v18.11.0+`\n- [NPM](https://www.npmjs.com/) (usually included with Node.js)\n- SQL database\n\n### Installation\n\nTo install the project on your computer, follow these steps:\n\n1. Clone the repository to your local machine.\n\n   ```bash\n   git clone https://github.com/TonyMckes/conduit-realworld-example-app.git\n   ```\n\n2. Navigate to the project directory.\n\n   ```bash\n   cd conduit-realworld-example-app\n   ```\n\n3. Install project dependencies by running the command:\n\n   ```bash\n   npm install\n   ```\n\n### Configuration\n\n1. Create a `.env` file in the root directory of the project\n2. Add the required environment variables as specified in the [`.env.example`](backend/.env.example) file\n3. (Optional) update the Sequelize configuration parameters in the [`config.js`](backend/config/config.js) file\n4. If you are **not** using PostgreSQL, you may also have to install the driver for your database:\n\n   \u003cdetails\u003e\n   \u003csummary\u003eUse one of the following commands to install:\u003c/summary\u003e\u003cbr/\u003e\n\n   \u003e Note: `-w backend` option is used to install it in the backend [`package.json`](backend/package.json).\n\n   ```bash\n   npm install -w backend pg pg-hstore  # Postgres (already installed)\n   npm install -w backend mysql2\n   npm install -w backend mariadb\n   npm install -w backend sqlite3\n   npm install -w backend tedious       # Microsoft SQL Server\n   npm install -w backend oracledb      # Oracle Database\n   ```\n\n   \u003e :information_source: Visit [Sequelize - Installing](https://sequelize.org/docs/v6/getting-started/#installing) for more infomation.\n\n   ***\n\n   \u003c/details\u003e\n\n5. Create database specified by configuration by executing\n\n   \u003e :warning: Please, make sure you have already created a superuser for your database.\n\n   ```bash\n   npm run sqlz -- db:create\n   ```\n\n   \u003e :information_source: The command `npm run sqlz` is an alias for `npx -w backend sequelize-cli`.  \n   \u003e Execute `npm run sqlz -- --help` to see more of `sequelize-cli` commands availables.\n\n6. Optionally you can run the following command to populate your database with some dummy data:\n\n   ```bash\n   npm run sqlz -- db:seed:all\n   ```\n\n### Usage\n\n#### Development Server\n\nTo run the project, follow these steps:\n\n1. Start the development server by executing the command:\n\n   ```bash\n   npm run dev\n   ```\n\n2. Open a web browser and navigate to:\n   - Home page should be available at [`http://localhost:3000/`](http://localhost:3000).\n   - API endpoints should be available at [`http://localhost:3001/api`](http://localhost:3001/api).\n\n#### Running Tests\n\nTo run tests, simply run the following command:\n\n```bash\nnpm run test\n```\n\n#### Production\n\nThe following command will build the production version of the app:\n\n```bash\nnpm run start\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [RealWorld](https://realworld.io/)\n- [RealWorld (GitHub)](https://github.com/gothinkster/realworld)\n- [CodebaseShow](https://codebase.show/)\n- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTonyMckes%2Fconduit-realworld-example-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTonyMckes%2Fconduit-realworld-example-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTonyMckes%2Fconduit-realworld-example-app/lists"}