{"id":14957661,"url":"https://github.com/prenext/suff","last_synced_at":"2026-01-06T11:46:44.055Z","repository":{"id":251496777,"uuid":"837595963","full_name":"prenext/suff","owner":"prenext","description":"Framework to create rest apis using node js","archived":false,"fork":false,"pushed_at":"2024-08-03T23:03:15.000Z","size":22,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-31T00:54:52.096Z","etag":null,"topics":["api","express","expressjs","framework","js","node","open-source","rest-api","server"],"latest_commit_sha":null,"homepage":"","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/prenext.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2024-08-03T12:46:09.000Z","updated_at":"2024-08-08T10:30:47.000Z","dependencies_parsed_at":"2024-08-03T23:19:34.498Z","dependency_job_id":null,"html_url":"https://github.com/prenext/suff","commit_stats":null,"previous_names":["prenext/api-js","prenext/epicjs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prenext%2Fsuff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prenext%2Fsuff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prenext%2Fsuff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prenext%2Fsuff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prenext","download_url":"https://codeload.github.com/prenext/suff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245579677,"owners_count":20638679,"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":["api","express","expressjs","framework","js","node","open-source","rest-api","server"],"created_at":"2024-09-24T13:15:18.421Z","updated_at":"2026-01-06T11:46:44.017Z","avatar_url":"https://github.com/prenext.png","language":"JavaScript","readme":"# suff\n\nWelcome to `suff` – a powerful and flexible framework designed to streamline the creation of REST APIs with Node.js and Express. Whether you’re a beginner looking for a quick setup or an experienced developer seeking a customizable solution, `suff` simplifies the process of building and configuring your APIs.\n\n## Overview\n\n`suff` automates the setup of common backend components, so you can focus on developing your application instead of spending time on boilerplate code and configuration. With `suff`, you can choose your preferred language (TypeScript or JavaScript) and database (Mongoose or Prisma) during installation. The framework also provides a well-structured folder layout and integrates useful tools like `dotenv` for environment management and logging capabilities.\n\n## Features\n\n- **Choose Your Language:** Options for TypeScript or JavaScript.\n- **Flexible Database Integration:** Supports Mongoose for MongoDB or Prisma for various databases.\n- **Automatic Configuration:** Sets up Express, MongoDB, and other dependencies.\n- **Structured Project Layout:** Creates folders for routes, controllers, models, utilities, and configuration.\n- **Open Source:** Contribute and collaborate with the community.\n\n## Project Structure\n\nWhen you set up your project with `suff`, the following folder structure will be created:\n\n```\nmy-api-project/\n├── config/          # Configuration files (e.g., environment settings)\n├── models/          # Database models\n├── routes/          # API routes\n├── utils/           # Utility functions and helpers\n├── .env             # Environment variables\n├── package.json     # Project dependencies and scripts\n├── tsconfig.json    # TypeScript configuration (if TypeScript is chosen)\n├── index.js         # Entry point for the application\n└── README.md        # Project documentation\n```\n\n## Installation and Usage\n\nTo get started with `suff`, follow these steps:\n\n1. **Install the Framework:**\n\n   Use `npx` to run the installation command:\n\n   ```bash\n   npx create-suff-server\n   ```\n\n   You'll be prompted to select your preferred language and database.\n\n2. **Navigate to Your Project Directory:**\n\n   ```bash\n   cd my-api-project\n   ```\n\n3. **Start the Development Server:**\n\n   Run the development server with:\n\n   ```bash\n   npm run dev\n   ```\n\n4. **Configure Your Environment:**\n\n   Edit the `.env` file to set up your environment variables and database connection settings. Make sure to specify the `NODE_ENV` variable:\n\n   ```env\n   NODE_ENV=development\n   ```\n\n5. **Develop Your API:**\n\n   - Define your routes in the `routes` folder.\n   - Implement your business logic in the `controllers` folder.\n   - Define your data models in the `models` folder.\n   - Use utilities from the `utils` folder as needed.\n\n## Configuration\n\n- **Environment Configuration:**\n  \n  `suff` uses environment variables specified in the `.env` file. The `NODE_ENV` variable determines if the application is running in development mode or production mode, affecting the setup of routes and other configurations.\n\n- **Commands:**\n\n  The framework provides several commands to interact with your project:\n  \n  - **`create-suff-server`**: Initializes a new `suff` project.\n  - **`suff`**: CLI tool with various commands:\n    - `dev`: Starts the development server with `nodemon` for auto-reloading.\n    - `build`: Builds the project for production.\n    - `start`: Starts the project in production mode.\n    - `test`: Runs tests for your project.\n\n## Contributing\n\nWe welcome contributions from the community! If you’d like to help improve `suff`, please follow these guidelines:\n\n- **Fork the Repository:** Create your own copy of the repository.\n- **Clone Your Fork:** Clone your fork to your local machine.\n- **Create a Branch:** Create a new branch for your changes.\n- **Commit Your Changes:** Commit your changes with a clear message.\n- **Push to GitHub:** Push your changes to your fork.\n- **Open a Pull Request:** Submit a pull request with a description of your changes.\n\n## License\n\n`suff` is open source and available under the [MIT License](LICENSE).\n\n## Contact\n\nFor any questions or feedback, please contact us at [mail@prenext.com].","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprenext%2Fsuff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprenext%2Fsuff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprenext%2Fsuff/lists"}