Skip to content

emingbt/ficsit-db

Repository files navigation

Ficsit DB

A comprehensive Satisfactory Encyclopedia that helps you while building efficient factory systems. Built by pioneers, for pioneers! 🚧

✨ Features

  • Complete Item Database: Browse through all Satisfactory items, buildings, and resources
  • Recipe Calculator: Calculate optimal production ratios and resource requirements
  • Blueprint HUB: Share your blueprints or find other pioneers' for your factory
  • Interactive Interface: User-friendly design for quick access to game information

banner

πŸš€ Quick Start

Prerequisites

  • Node.js (v18 or higher)
  • Yarn package manager

Installation

  1. Fork the repository on GitHub

  2. Clone your fork to your local machine:

    git clone [email protected]:emingbt/ficsit-db.git
    cd ficsit-db
  3. Install dependencies:

    yarn install
  4. Start the development server:

    yarn dev
  5. Open your browser and navigate to http://localhost:3000 (or the port shown in your terminal)

🎨 Design

Check out the complete design system and mockups on Figma: View Design File

πŸ› οΈ Technology Stack

  • Framework: Next.js
  • Styling: Tailwind CSS
  • Database: Postgres(neon) for user data and blueprints, Neo4j for game data
  • File Storage: Cloudinary for images and blueprints
  • Deployment: Vercel for hosting, GitHub Actions for CI/CD

πŸ“– About Satisfactory

Satisfactory is a first-person open-world factory building game where you explore an alien planet, mine resources, and build increasingly complex automated factories. Ficsit DB serves as your companion tool to optimize production chains and factory designs.

🀝 Contributing

We welcome contributions from the Satisfactory community! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Contribution Guidelines

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages
  • Be respectful and constructive in discussions

πŸ› Bug Reports & Feature Requests

Found a bug or have an idea for a new feature? Please:

  1. Check existing issues to avoid duplicates
  2. Create a new issue with a clear description
  3. Include steps to reproduce (for bugs)
  4. Add relevant labels and screenshots if applicable

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2022 Emin Gâbütoğlu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🎯 Project Status

This project is currently under active development (🚧). We're continuously adding new features and improving the user experience based on community feedback.

πŸ’¬ Community & Support

  • Issues: Report bugs and request features via GitHub Issues
  • Discussions: Join conversations in GitHub Discussions
  • Social: Follow updates and connect with other pioneers

πŸ™ Acknowledgments


Happy Constructing!⚑

Back to work, and Stay Effective.

About

A Satisfactory Encyclopedia that helps you while building systems 🚧

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages